{"openapi":"3.1.0","info":{"title":"Ship Messages API","version":"2026-08-21","description":"Public API (§13A). Generated from the route schemas; divergence is a build failure (§115)."},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"sk_live_… / sk_test_… (§10.2)"},"scimToken":{"type":"http","scheme":"bearer","description":"The SCIM provisioning token issued for the directory endpoint (§109), not an API key."}},"schemas":{}},"paths":{"/v1/accounts/{AC}/messages/preflight":{"post":{"summary":"Preflight a message without creating it","tags":["messages"],"description":"Check whether a message would be accepted, and what it would cost, without creating it. Takes the same body as sending.\n\nAccount-scoped credential: Required scope: `messages:send`.\n\nAlternatively, a normal tenant USER session may use `messages:send` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.\n\nThis reply alternative requires conversationSid and a valid composerClaimToken. from must be omitted or the exact conversation sender SID; sender pools and composer overrides require account-level authorization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"conversationSid":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID for an agent inbox reply","type":"string"},"composerClaimToken":{"format":"uuid","type":"string"},"composerOverrideReason":{"minLength":1,"maxLength":1000,"type":"string"},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"senderPoolSid":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender pool SID","type":"string"},"to":{"description":"E.164 recipient (whatsapp: prefix accepted and stripped)","maxLength":32,"type":"string"},"recipient":{"additionalProperties":false,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"minLength":1,"maxLength":64,"type":"string"}}},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","description":"Contact SID; addresses an existing contact directly (§101.3)","type":"string"},"defaultCountry":{"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country used to read a national phone number (NG reads 08031234567 as +2348031234567). Without it the number must start with + or 00.","type":"string"},"type":{"anyOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["template"]},{"type":"string","enum":["image"]},{"type":"string","enum":["video"]},{"type":"string","enum":["audio"]},{"type":"string","enum":["document"]},{"type":"string","enum":["sticker"]},{"type":"string","enum":["location"]},{"type":"string","enum":["contacts"]},{"type":"string","enum":["reaction"]},{"type":"string","enum":["interactive"]},{"type":"string","enum":["product"]},{"type":"string","enum":["catalog"]},{"type":"string","enum":["flow"]},{"type":"string","enum":["product_list"]},{"type":"string","enum":["address"]},{"type":"string","enum":["carousel"]}]},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","description":"Reusable content SID; alternative to type/template","type":"string"},"variables":{"maxProperties":100,"type":"object","additionalProperties":{"maxLength":4096,"type":"string"}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":false,"type":"object","required":["name","language"],"properties":{"name":{"minLength":1,"maxLength":512,"type":"string"},"language":{"minLength":2,"maxLength":16,"type":"string"},"components":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["type"],"properties":{"type":{"anyOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["body"]},{"type":"string","enum":["button"]},{"type":"string","enum":["limited_time_offer"]},{"type":"string","enum":["tap_target_configuration"]}]},"subType":{"anyOf":[{"type":"string","enum":["quick_reply"]},{"type":"string","enum":["url"]},{"type":"string","enum":["copy_code"]},{"type":"string","enum":["otp"]},{"type":"string","enum":["catalog"]},{"type":"string","enum":["flow"]},{"type":"string","enum":["mpm"]},{"type":"string","enum":["spm"]}]},"index":{"minimum":0,"maximum":9,"type":"integer"},"parameters":{"type":"array","items":{"anyOf":[{"additionalProperties":false,"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"]},"text":{"maxLength":1024,"type":"string"},"parameterName":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","fallbackValue","code","amount1000"],"properties":{"type":{"type":"string","enum":["currency"]},"fallbackValue":{"type":"string"},"code":{"minLength":3,"maxLength":3,"type":"string"},"amount1000":{"type":"integer"}}},{"additionalProperties":false,"type":"object","required":["type","fallbackValue"],"properties":{"type":{"type":"string","enum":["date_time"]},"fallbackValue":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","enum":["payload"]},"payload":{"maxLength":256,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["image"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY image media SID","type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["video"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY video media SID","type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["document"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY document media SID","type":"string"},"filename":{"minLength":1,"maxLength":255,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","latitude","longitude"],"properties":{"type":{"type":"string","enum":["location"]},"latitude":{"minimum":-90,"maximum":90,"type":"number"},"longitude":{"minimum":-180,"maximum":180,"type":"number"},"name":{"maxLength":1000,"type":"string"},"address":{"maxLength":1000,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","couponCode"],"properties":{"type":{"type":"string","enum":["coupon_code"]},"couponCode":{"minLength":1,"maxLength":15,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","expirationTimeMs"],"properties":{"type":{"type":"string","enum":["limited_time_offer"]},"expirationTimeMs":{"minimum":1,"description":"When the offer ends (epoch ms)","type":"integer"}}},{"additionalProperties":false,"type":"object","required":["type","url","title"],"properties":{"type":{"type":"string","enum":["tap_target_configuration"]},"url":{"format":"uri","maxLength":2000,"type":"string"},"title":{"minLength":1,"maxLength":60,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["action"]},"thumbnailProductRetailerId":{"minLength":1,"maxLength":256,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},{"additionalProperties":false,"type":"object","required":["type","catalogId","productRetailerId"],"properties":{"type":{"type":"string","enum":["product"]},"catalogId":{"minLength":1,"maxLength":256,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}]}}}}}}},"media":{"additionalProperties":false,"type":"object","required":["sid"],"properties":{"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"Media SID; must be READY","type":"string"},"caption":{"maxLength":1024,"type":"string"},"filename":{"minLength":1,"maxLength":255,"type":"string"},"voice":{"type":"boolean"}}},"location":{"additionalProperties":false,"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"minimum":-90,"maximum":90,"type":"number"},"longitude":{"minimum":-180,"maximum":180,"type":"number"},"name":{"maxLength":1000,"type":"string"},"address":{"maxLength":1000,"type":"string"}}},"contacts":{"additionalProperties":false,"type":"object","required":["contacts"],"properties":{"contacts":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["formattedName"],"properties":{"formattedName":{"minLength":1,"maxLength":256,"type":"string"},"firstName":{"maxLength":128,"type":"string"},"lastName":{"maxLength":128,"type":"string"},"phones":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["value"],"properties":{"value":{"minLength":1,"maxLength":32,"type":"string"},"type":{"maxLength":32,"type":"string"}}}},"emails":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["value"],"properties":{"value":{"minLength":3,"maxLength":320,"type":"string"},"type":{"maxLength":32,"type":"string"}}}}}}}}},"reaction":{"additionalProperties":false,"type":"object","required":["targetMessageId","emoji"],"properties":{"targetMessageId":{"minLength":1,"maxLength":256,"type":"string"},"emoji":{"maxLength":16,"type":"string"}}},"interactive":{"anyOf":[{"additionalProperties":false,"type":"object","required":["subtype","body","buttons"],"properties":{"subtype":{"type":"string","enum":["button"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"buttons":{"minItems":1,"maxItems":3,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","title"],"properties":{"id":{"minLength":1,"maxLength":256,"type":"string"},"title":{"minLength":1,"maxLength":20,"type":"string"}}}}}},{"additionalProperties":false,"type":"object","required":["subtype","body","button","sections"],"properties":{"subtype":{"type":"string","enum":["list"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"button":{"minLength":1,"maxLength":20,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["rows"],"properties":{"title":{"maxLength":24,"type":"string"},"rows":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","title"],"properties":{"id":{"minLength":1,"maxLength":200,"type":"string"},"title":{"minLength":1,"maxLength":24,"type":"string"},"description":{"maxLength":72,"type":"string"}}}}}}}}},{"additionalProperties":false,"type":"object","required":["subtype","body","displayText","url"],"properties":{"subtype":{"type":"string","enum":["cta_url"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"displayText":{"minLength":1,"maxLength":20,"type":"string"},"url":{"format":"uri","maxLength":2048,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["subtype","body"],"properties":{"subtype":{"type":"string","enum":["location_request"]},"body":{"minLength":1,"maxLength":1024,"type":"string"}}},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["catalogId","header","sections"],"properties":{"subtype":{"type":"string","enum":["product_list"]},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"header":{"minLength":1,"maxLength":60,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["product_list"]}}}]},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["body","country"],"properties":{"subtype":{"type":"string","enum":["address"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"country":{"anyOf":[{"type":"string","enum":["IN"]},{"type":"string","enum":["SG"]}]},"values":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"validationErrors":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"savedAddresses":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","value"],"properties":{"id":{"minLength":1,"maxLength":128,"type":"string"},"value":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["address"]}}}]},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["body","cards"],"properties":{"subtype":{"type":"string","enum":["carousel"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"cards":{"minItems":2,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["cardIndex","catalogId","productRetailerId"],"properties":{"cardIndex":{"minimum":0,"maximum":9,"type":"integer"},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["carousel"]}}}]}]},"product":{"additionalProperties":false,"type":"object","required":["catalogId","productRetailerId"],"properties":{"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"}}},"catalog":{"additionalProperties":false,"type":"object","required":["catalogId","body"],"properties":{"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"thumbnailProductRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}},"flow":{"additionalProperties":false,"type":"object","required":["flowSid","body","ctaText"],"properties":{"flowSid":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","description":"Published Flow SID","type":"string"},"body":{"minLength":1,"maxLength":1024,"type":"string"},"ctaText":{"minLength":1,"maxLength":20,"type":"string"},"action":{"anyOf":[{"type":"string","enum":["navigate"]},{"type":"string","enum":["data_exchange"]}]},"screen":{"minLength":1,"maxLength":128,"type":"string"},"data":{"additionalProperties":true,"type":"object","properties":{}}}},"productList":{"additionalProperties":false,"type":"object","required":["catalogId","header","sections"],"properties":{"subtype":{"type":"string","enum":["product_list"]},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"header":{"minLength":1,"maxLength":60,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},"address":{"additionalProperties":false,"type":"object","required":["body","country"],"properties":{"subtype":{"type":"string","enum":["address"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"country":{"anyOf":[{"type":"string","enum":["IN"]},{"type":"string","enum":["SG"]}]},"values":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"validationErrors":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"savedAddresses":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","value"],"properties":{"id":{"minLength":1,"maxLength":128,"type":"string"},"value":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}}}}}}},"carousel":{"additionalProperties":false,"type":"object","required":["body","cards"],"properties":{"subtype":{"type":"string","enum":["carousel"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"cards":{"minItems":2,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["cardIndex","catalogId","productRetailerId"],"properties":{"cardIndex":{"minimum":0,"maximum":9,"type":"integer"},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"context":{"additionalProperties":false,"type":"object","properties":{"replyToMessageId":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"providerMessageId":{"maxLength":256,"type":"string"}}},"priority":{"anyOf":[{"type":"string","enum":["P0"]},{"type":"string","enum":["P1"]},{"type":"string","enum":["P2"]},{"type":"string","enum":["P3"]}]},"sendAt":{"format":"date-time","description":"RFC 3339; ≤ 35 days ahead","type":"string"},"validityPeriodSeconds":{"minimum":30,"maximum":2592000,"type":"integer"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":false,"type":"object","properties":{"ttlSeconds":{"minimum":43200,"maximum":2592000,"type":"integer"}}},"deferIfCapped":{"description":"Defer marketing sends until a recipient cap clears","type":"boolean"},"category":{"description":"Derived from the template when absent; must match it when present (§13A.3)","anyOf":[{"type":"string","enum":["authentication"]},{"type":"string","enum":["utility"]},{"type":"string","enum":["marketing"]},{"type":"string","enum":["service"]}]},"statusCallbackUrl":{"format":"uri","maxLength":2048,"type":"string"},"statusCallbackSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","description":"Verified webhook endpoint SID; alternative to statusCallbackUrl (§13)","type":"string"},"metadata":{"maxProperties":16,"type":"object","additionalProperties":{"maxLength":512,"type":"string"}},"tags":{"maxItems":10,"type":"array","items":{"maxLength":40,"type":"string"}}}},"example":{"from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":"+14155550123","type":"text","text":{"body":"Hello"}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:send"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"messages:send","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true,"replyBinding":{"conversationSidRequired":true,"composerClaimTokenRequired":true,"from":"OMITTED_OR_EXACT_CONVERSATION_SENDER_SID","senderPoolAllowed":false,"composerOverrideAllowed":false}}}},"/v1/accounts/{AC}/messages":{"post":{"summary":"Create a message","tags":["messages"],"description":"Send one WhatsApp message. The request is accepted (202) once it is stored and admitted; delivery progress arrives as `message.*` webhook events and on the message itself. Send an `Idempotency-Key` header so a retry never sends twice. Outside the 24-hour customer service window only an approved template can be sent.\n\nAccount-scoped credential: Required scope: `messages:send`.\n\nAlternatively, a normal tenant USER session may use `messages:send` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.\n\nThis reply alternative requires conversationSid and a valid composerClaimToken. from must be omitted or the exact conversation sender SID; sender pools and composer overrides require account-level authorization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"conversationSid":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID for an agent inbox reply","type":"string"},"composerClaimToken":{"format":"uuid","type":"string"},"composerOverrideReason":{"minLength":1,"maxLength":1000,"type":"string"},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"senderPoolSid":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender pool SID","type":"string"},"to":{"description":"E.164 recipient (whatsapp: prefix accepted and stripped)","maxLength":32,"type":"string"},"recipient":{"additionalProperties":false,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"minLength":1,"maxLength":64,"type":"string"}}},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","description":"Contact SID; addresses an existing contact directly (§101.3)","type":"string"},"defaultCountry":{"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country used to read a national phone number (NG reads 08031234567 as +2348031234567). Without it the number must start with + or 00.","type":"string"},"type":{"anyOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["template"]},{"type":"string","enum":["image"]},{"type":"string","enum":["video"]},{"type":"string","enum":["audio"]},{"type":"string","enum":["document"]},{"type":"string","enum":["sticker"]},{"type":"string","enum":["location"]},{"type":"string","enum":["contacts"]},{"type":"string","enum":["reaction"]},{"type":"string","enum":["interactive"]},{"type":"string","enum":["product"]},{"type":"string","enum":["catalog"]},{"type":"string","enum":["flow"]},{"type":"string","enum":["product_list"]},{"type":"string","enum":["address"]},{"type":"string","enum":["carousel"]}]},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","description":"Reusable content SID; alternative to type/template","type":"string"},"variables":{"maxProperties":100,"type":"object","additionalProperties":{"maxLength":4096,"type":"string"}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":false,"type":"object","required":["name","language"],"properties":{"name":{"minLength":1,"maxLength":512,"type":"string"},"language":{"minLength":2,"maxLength":16,"type":"string"},"components":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["type"],"properties":{"type":{"anyOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["body"]},{"type":"string","enum":["button"]},{"type":"string","enum":["limited_time_offer"]},{"type":"string","enum":["tap_target_configuration"]}]},"subType":{"anyOf":[{"type":"string","enum":["quick_reply"]},{"type":"string","enum":["url"]},{"type":"string","enum":["copy_code"]},{"type":"string","enum":["otp"]},{"type":"string","enum":["catalog"]},{"type":"string","enum":["flow"]},{"type":"string","enum":["mpm"]},{"type":"string","enum":["spm"]}]},"index":{"minimum":0,"maximum":9,"type":"integer"},"parameters":{"type":"array","items":{"anyOf":[{"additionalProperties":false,"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"]},"text":{"maxLength":1024,"type":"string"},"parameterName":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","fallbackValue","code","amount1000"],"properties":{"type":{"type":"string","enum":["currency"]},"fallbackValue":{"type":"string"},"code":{"minLength":3,"maxLength":3,"type":"string"},"amount1000":{"type":"integer"}}},{"additionalProperties":false,"type":"object","required":["type","fallbackValue"],"properties":{"type":{"type":"string","enum":["date_time"]},"fallbackValue":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","enum":["payload"]},"payload":{"maxLength":256,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["image"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY image media SID","type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["video"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY video media SID","type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["document"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY document media SID","type":"string"},"filename":{"minLength":1,"maxLength":255,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","latitude","longitude"],"properties":{"type":{"type":"string","enum":["location"]},"latitude":{"minimum":-90,"maximum":90,"type":"number"},"longitude":{"minimum":-180,"maximum":180,"type":"number"},"name":{"maxLength":1000,"type":"string"},"address":{"maxLength":1000,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","couponCode"],"properties":{"type":{"type":"string","enum":["coupon_code"]},"couponCode":{"minLength":1,"maxLength":15,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","expirationTimeMs"],"properties":{"type":{"type":"string","enum":["limited_time_offer"]},"expirationTimeMs":{"minimum":1,"description":"When the offer ends (epoch ms)","type":"integer"}}},{"additionalProperties":false,"type":"object","required":["type","url","title"],"properties":{"type":{"type":"string","enum":["tap_target_configuration"]},"url":{"format":"uri","maxLength":2000,"type":"string"},"title":{"minLength":1,"maxLength":60,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["action"]},"thumbnailProductRetailerId":{"minLength":1,"maxLength":256,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},{"additionalProperties":false,"type":"object","required":["type","catalogId","productRetailerId"],"properties":{"type":{"type":"string","enum":["product"]},"catalogId":{"minLength":1,"maxLength":256,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}]}}}}}}},"media":{"additionalProperties":false,"type":"object","required":["sid"],"properties":{"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"Media SID; must be READY","type":"string"},"caption":{"maxLength":1024,"type":"string"},"filename":{"minLength":1,"maxLength":255,"type":"string"},"voice":{"type":"boolean"}}},"location":{"additionalProperties":false,"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"minimum":-90,"maximum":90,"type":"number"},"longitude":{"minimum":-180,"maximum":180,"type":"number"},"name":{"maxLength":1000,"type":"string"},"address":{"maxLength":1000,"type":"string"}}},"contacts":{"additionalProperties":false,"type":"object","required":["contacts"],"properties":{"contacts":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["formattedName"],"properties":{"formattedName":{"minLength":1,"maxLength":256,"type":"string"},"firstName":{"maxLength":128,"type":"string"},"lastName":{"maxLength":128,"type":"string"},"phones":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["value"],"properties":{"value":{"minLength":1,"maxLength":32,"type":"string"},"type":{"maxLength":32,"type":"string"}}}},"emails":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["value"],"properties":{"value":{"minLength":3,"maxLength":320,"type":"string"},"type":{"maxLength":32,"type":"string"}}}}}}}}},"reaction":{"additionalProperties":false,"type":"object","required":["targetMessageId","emoji"],"properties":{"targetMessageId":{"minLength":1,"maxLength":256,"type":"string"},"emoji":{"maxLength":16,"type":"string"}}},"interactive":{"anyOf":[{"additionalProperties":false,"type":"object","required":["subtype","body","buttons"],"properties":{"subtype":{"type":"string","enum":["button"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"buttons":{"minItems":1,"maxItems":3,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","title"],"properties":{"id":{"minLength":1,"maxLength":256,"type":"string"},"title":{"minLength":1,"maxLength":20,"type":"string"}}}}}},{"additionalProperties":false,"type":"object","required":["subtype","body","button","sections"],"properties":{"subtype":{"type":"string","enum":["list"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"button":{"minLength":1,"maxLength":20,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["rows"],"properties":{"title":{"maxLength":24,"type":"string"},"rows":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","title"],"properties":{"id":{"minLength":1,"maxLength":200,"type":"string"},"title":{"minLength":1,"maxLength":24,"type":"string"},"description":{"maxLength":72,"type":"string"}}}}}}}}},{"additionalProperties":false,"type":"object","required":["subtype","body","displayText","url"],"properties":{"subtype":{"type":"string","enum":["cta_url"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"displayText":{"minLength":1,"maxLength":20,"type":"string"},"url":{"format":"uri","maxLength":2048,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["subtype","body"],"properties":{"subtype":{"type":"string","enum":["location_request"]},"body":{"minLength":1,"maxLength":1024,"type":"string"}}},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["catalogId","header","sections"],"properties":{"subtype":{"type":"string","enum":["product_list"]},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"header":{"minLength":1,"maxLength":60,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["product_list"]}}}]},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["body","country"],"properties":{"subtype":{"type":"string","enum":["address"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"country":{"anyOf":[{"type":"string","enum":["IN"]},{"type":"string","enum":["SG"]}]},"values":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"validationErrors":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"savedAddresses":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","value"],"properties":{"id":{"minLength":1,"maxLength":128,"type":"string"},"value":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["address"]}}}]},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["body","cards"],"properties":{"subtype":{"type":"string","enum":["carousel"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"cards":{"minItems":2,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["cardIndex","catalogId","productRetailerId"],"properties":{"cardIndex":{"minimum":0,"maximum":9,"type":"integer"},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["carousel"]}}}]}]},"product":{"additionalProperties":false,"type":"object","required":["catalogId","productRetailerId"],"properties":{"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"}}},"catalog":{"additionalProperties":false,"type":"object","required":["catalogId","body"],"properties":{"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"thumbnailProductRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}},"flow":{"additionalProperties":false,"type":"object","required":["flowSid","body","ctaText"],"properties":{"flowSid":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","description":"Published Flow SID","type":"string"},"body":{"minLength":1,"maxLength":1024,"type":"string"},"ctaText":{"minLength":1,"maxLength":20,"type":"string"},"action":{"anyOf":[{"type":"string","enum":["navigate"]},{"type":"string","enum":["data_exchange"]}]},"screen":{"minLength":1,"maxLength":128,"type":"string"},"data":{"additionalProperties":true,"type":"object","properties":{}}}},"productList":{"additionalProperties":false,"type":"object","required":["catalogId","header","sections"],"properties":{"subtype":{"type":"string","enum":["product_list"]},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"header":{"minLength":1,"maxLength":60,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},"address":{"additionalProperties":false,"type":"object","required":["body","country"],"properties":{"subtype":{"type":"string","enum":["address"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"country":{"anyOf":[{"type":"string","enum":["IN"]},{"type":"string","enum":["SG"]}]},"values":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"validationErrors":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"savedAddresses":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","value"],"properties":{"id":{"minLength":1,"maxLength":128,"type":"string"},"value":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}}}}}}},"carousel":{"additionalProperties":false,"type":"object","required":["body","cards"],"properties":{"subtype":{"type":"string","enum":["carousel"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"cards":{"minItems":2,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["cardIndex","catalogId","productRetailerId"],"properties":{"cardIndex":{"minimum":0,"maximum":9,"type":"integer"},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"context":{"additionalProperties":false,"type":"object","properties":{"replyToMessageId":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"providerMessageId":{"maxLength":256,"type":"string"}}},"priority":{"anyOf":[{"type":"string","enum":["P0"]},{"type":"string","enum":["P1"]},{"type":"string","enum":["P2"]},{"type":"string","enum":["P3"]}]},"sendAt":{"format":"date-time","description":"RFC 3339; ≤ 35 days ahead","type":"string"},"validityPeriodSeconds":{"minimum":30,"maximum":2592000,"type":"integer"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":false,"type":"object","properties":{"ttlSeconds":{"minimum":43200,"maximum":2592000,"type":"integer"}}},"deferIfCapped":{"description":"Defer marketing sends until a recipient cap clears","type":"boolean"},"category":{"description":"Derived from the template when absent; must match it when present (§13A.3)","anyOf":[{"type":"string","enum":["authentication"]},{"type":"string","enum":["utility"]},{"type":"string","enum":["marketing"]},{"type":"string","enum":["service"]}]},"statusCallbackUrl":{"format":"uri","maxLength":2048,"type":"string"},"statusCallbackSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","description":"Verified webhook endpoint SID; alternative to statusCallbackUrl (§13)","type":"string"},"metadata":{"maxProperties":16,"type":"object","additionalProperties":{"maxLength":512,"type":"string"}},"tags":{"maxItems":10,"type":"array","items":{"maxLength":40,"type":"string"}}}},"example":{"from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":"+14155550123","type":"template","contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variables":{"1":"Ada","2":"order 4417"},"metadata":{"orderId":"4417"}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","status","direction","from","to","type","priority","livemode","providerMessageId","campaignSid","conversationSid","sentByPrincipal","pricing","providerAccepted","heldForQuality","providerPaused","attempt","queuedReason","readyAt","sendAt","deliverBefore","transport","transportOptions","cancelRequested","unknownSince","deletedByUser","redacted","contentUnreadable","warnings","duplicateDetected","metadata","tags","statusCallbackUrl","createdAt","updatedAt","sentAt","deliveredAt","readAt"],"properties":{"object":{"type":"string","enum":["message"]},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"status":{"description":"queued | scheduled | sending | sent | delivered | read | played | failed | canceled | expired | unknown","type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound"]},{"type":"string","enum":["inbound"]}]},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"to":{"additionalProperties":true,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"masked":{"description":"True when `value` is masked (+33 6•• •• •• 78) because the caller lacks contacts:read_identifiers (§50).","type":"boolean"}}},"type":{"type":"string"},"priority":{"type":"string"},"livemode":{"type":"boolean"},"providerMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignSid":{"anyOf":[{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","description":"Campaign SID","type":"string"},{"type":"null"}]},"conversationSid":{"anyOf":[{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID","type":"string"},{"type":"null"}]},"sentByPrincipal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","required":["category","model","customerChargeMinor","currency"],"properties":{"category":{"type":"string"},"model":{"type":"string"},"customerChargeMinor":{"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"description":"Decimal places customerChargeMinor is counted in (JPY 0, USD 2, KWD 3).","type":"integer"}}},{"type":"null"}]},"providerAccepted":{"type":"boolean"},"heldForQuality":{"type":"boolean"},"providerPaused":{"type":"boolean"},"attempt":{"type":"integer"},"queuedReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliverBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":true,"type":"object","properties":{}},"cancelRequested":{"type":"boolean"},"unknownSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedByUser":{"type":"boolean"},"redacted":{"type":"boolean"},"contentUnreadable":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}},"duplicateDetected":{"type":"boolean"},"error":{"additionalProperties":true,"type":"object","properties":{}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":true,"type":"object","properties":{}},"media":{"additionalProperties":true,"type":"object","properties":{}},"location":{"additionalProperties":true,"type":"object","properties":{}},"contacts":{"additionalProperties":true,"type":"object","properties":{}},"reaction":{"additionalProperties":true,"type":"object","properties":{}},"interactive":{"additionalProperties":true,"type":"object","properties":{}},"context":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"sentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveredAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","required":["type","occurredAt","attempt","reason"],"properties":{"type":{"type":"string"},"occurredAt":{"type":"string"},"attempt":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"example":{"object":"message","sid":"SM01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"status","direction":"outbound","from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":{"identifierType":"identifierType","value":"value"},"type":"type","priority":"priority","livemode":false,"providerMessageId":"providerMessageId","campaignSid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","conversationSid":"CO01J8Z3K4M5N6P7Q8R9S0T1V2W3","sentByPrincipal":"sentByPrincipal","pricing":{"category":"category","model":"model","customerChargeMinor":1,"currency":"USD"},"providerAccepted":false,"heldForQuality":false,"providerPaused":false,"attempt":1,"queuedReason":"queuedReason","readyAt":"readyAt","sendAt":"sendAt","deliverBefore":"deliverBefore","transport":"cloud_api","transportOptions":{},"cancelRequested":false,"unknownSince":"unknownSince","deletedByUser":false,"redacted":false,"contentUnreadable":false,"warnings":["warnings"],"duplicateDetected":false,"metadata":{},"tags":["tags"],"statusCallbackUrl":"statusCallbackUrl","createdAt":"createdAt","updatedAt":"updatedAt","sentAt":"sentAt","deliveredAt":"deliveredAt","readAt":"readAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:send"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"messages:send","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true,"replyBinding":{"conversationSidRequired":true,"composerClaimTokenRequired":true,"from":"OMITTED_OR_EXACT_CONVERSATION_SENDER_SID","senderPoolAllowed":false,"composerOverrideAllowed":false}}},"get":{"summary":"List messages","tags":["messages"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"maxLength":32,"type":"string"},"in":"query","name":"status","required":false},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"from","required":false},{"schema":{"minLength":1,"maxLength":128,"type":"string"},"in":"query","name":"to","required":false},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"contactSid","required":false},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"campaignSid","required":false},{"schema":{"pattern":"^MB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"batchSid","required":false},{"schema":{"anyOf":[{"type":"string","enum":["outbound"]},{"type":"string","enum":["inbound"]}]},"in":"query","name":"direction","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"createdAfter","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"createdBefore","required":false},{"schema":{"maxLength":40,"type":"string"},"in":"query","name":"tag","required":false},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"templateSid","required":false},{"schema":{"minLength":1,"maxLength":512,"type":"string"},"in":"query","name":"templateName","required":false},{"schema":{"minLength":1,"maxLength":256,"type":"string"},"in":"query","name":"providerMessageId","required":false},{"schema":{"maxLength":3299,"type":"string"},"in":"query","name":"sids","required":false},{"schema":{"anyOf":[{"type":"string","enum":["createdAt"]},{"type":"string","enum":["-createdAt"]}]},"in":"query","name":"sort","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["object","sid","status","direction","from","to","type","priority","livemode","providerMessageId","campaignSid","conversationSid","sentByPrincipal","pricing","providerAccepted","heldForQuality","providerPaused","attempt","queuedReason","readyAt","sendAt","deliverBefore","transport","transportOptions","cancelRequested","unknownSince","deletedByUser","redacted","contentUnreadable","warnings","duplicateDetected","metadata","tags","statusCallbackUrl","createdAt","updatedAt","sentAt","deliveredAt","readAt"],"properties":{"object":{"type":"string","enum":["message"]},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"status":{"description":"queued | scheduled | sending | sent | delivered | read | played | failed | canceled | expired | unknown","type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound"]},{"type":"string","enum":["inbound"]}]},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"to":{"additionalProperties":true,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"masked":{"description":"True when `value` is masked (+33 6•• •• •• 78) because the caller lacks contacts:read_identifiers (§50).","type":"boolean"}}},"type":{"type":"string"},"priority":{"type":"string"},"livemode":{"type":"boolean"},"providerMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignSid":{"anyOf":[{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","description":"Campaign SID","type":"string"},{"type":"null"}]},"conversationSid":{"anyOf":[{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID","type":"string"},{"type":"null"}]},"sentByPrincipal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","required":["category","model","customerChargeMinor","currency"],"properties":{"category":{"type":"string"},"model":{"type":"string"},"customerChargeMinor":{"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"description":"Decimal places customerChargeMinor is counted in (JPY 0, USD 2, KWD 3).","type":"integer"}}},{"type":"null"}]},"providerAccepted":{"type":"boolean"},"heldForQuality":{"type":"boolean"},"providerPaused":{"type":"boolean"},"attempt":{"type":"integer"},"queuedReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliverBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":true,"type":"object","properties":{}},"cancelRequested":{"type":"boolean"},"unknownSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedByUser":{"type":"boolean"},"redacted":{"type":"boolean"},"contentUnreadable":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}},"duplicateDetected":{"type":"boolean"},"error":{"additionalProperties":true,"type":"object","properties":{}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":true,"type":"object","properties":{}},"media":{"additionalProperties":true,"type":"object","properties":{}},"location":{"additionalProperties":true,"type":"object","properties":{}},"contacts":{"additionalProperties":true,"type":"object","properties":{}},"reaction":{"additionalProperties":true,"type":"object","properties":{}},"interactive":{"additionalProperties":true,"type":"object","properties":{}},"context":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"sentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveredAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","required":["type","occurredAt","attempt","reason"],"properties":{"type":{"type":"string"},"occurredAt":{"type":"string"},"attempt":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}},"example":{"data":[{"object":"message","sid":"SM01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"status","direction":"outbound","from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":{"identifierType":"identifierType","value":"value"},"type":"type","priority":"priority","livemode":false,"providerMessageId":"providerMessageId","campaignSid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","conversationSid":"CO01J8Z3K4M5N6P7Q8R9S0T1V2W3","sentByPrincipal":"sentByPrincipal","pricing":{"category":"category","model":"model","customerChargeMinor":1,"currency":"USD"},"providerAccepted":false,"heldForQuality":false,"providerPaused":false,"attempt":1,"queuedReason":"queuedReason","readyAt":"readyAt","sendAt":"sendAt","deliverBefore":"deliverBefore","transport":"cloud_api","transportOptions":{},"cancelRequested":false,"unknownSince":"unknownSince","deletedByUser":false,"redacted":false,"contentUnreadable":false,"warnings":["warnings"],"duplicateDetected":false,"metadata":{},"tags":["tags"],"statusCallbackUrl":"statusCallbackUrl","createdAt":"createdAt","updatedAt":"updatedAt","sentAt":"sentAt","deliveredAt":"deliveredAt","readAt":"readAt"}],"hasMore":false,"nextCursor":"nextCursor","dataAsOf":"dataAsOf"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:read"],"description":"List messages, newest first. Filter by status, sender, recipient or time range; follow `nextCursor` to page.\n\nRequired scope: `messages:read`."}},"/v1/me":{"get":{"summary":"Discover the API key's account and region","tags":["identity"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","accountSid","keySid","environment","homeRegion","scopes"],"properties":{"object":{"type":"string","enum":["api_key_context"]},"accountSid":{"type":"string"},"keySid":{"type":"string"},"environment":{"anyOf":[{"type":"string","enum":["live"]},{"type":"string","enum":["sandbox"]}]},"homeRegion":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/accounts/{AC}/messages/{SM}":{"get":{"summary":"Fetch a message","tags":["messages"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SM","required":true,"description":"Message SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","status","direction","from","to","type","priority","livemode","providerMessageId","campaignSid","conversationSid","sentByPrincipal","pricing","providerAccepted","heldForQuality","providerPaused","attempt","queuedReason","readyAt","sendAt","deliverBefore","transport","transportOptions","cancelRequested","unknownSince","deletedByUser","redacted","contentUnreadable","warnings","duplicateDetected","metadata","tags","statusCallbackUrl","createdAt","updatedAt","sentAt","deliveredAt","readAt"],"properties":{"object":{"type":"string","enum":["message"]},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"status":{"description":"queued | scheduled | sending | sent | delivered | read | played | failed | canceled | expired | unknown","type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound"]},{"type":"string","enum":["inbound"]}]},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"to":{"additionalProperties":true,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"masked":{"description":"True when `value` is masked (+33 6•• •• •• 78) because the caller lacks contacts:read_identifiers (§50).","type":"boolean"}}},"type":{"type":"string"},"priority":{"type":"string"},"livemode":{"type":"boolean"},"providerMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignSid":{"anyOf":[{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","description":"Campaign SID","type":"string"},{"type":"null"}]},"conversationSid":{"anyOf":[{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID","type":"string"},{"type":"null"}]},"sentByPrincipal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","required":["category","model","customerChargeMinor","currency"],"properties":{"category":{"type":"string"},"model":{"type":"string"},"customerChargeMinor":{"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"description":"Decimal places customerChargeMinor is counted in (JPY 0, USD 2, KWD 3).","type":"integer"}}},{"type":"null"}]},"providerAccepted":{"type":"boolean"},"heldForQuality":{"type":"boolean"},"providerPaused":{"type":"boolean"},"attempt":{"type":"integer"},"queuedReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliverBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":true,"type":"object","properties":{}},"cancelRequested":{"type":"boolean"},"unknownSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedByUser":{"type":"boolean"},"redacted":{"type":"boolean"},"contentUnreadable":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}},"duplicateDetected":{"type":"boolean"},"error":{"additionalProperties":true,"type":"object","properties":{}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":true,"type":"object","properties":{}},"media":{"additionalProperties":true,"type":"object","properties":{}},"location":{"additionalProperties":true,"type":"object","properties":{}},"contacts":{"additionalProperties":true,"type":"object","properties":{}},"reaction":{"additionalProperties":true,"type":"object","properties":{}},"interactive":{"additionalProperties":true,"type":"object","properties":{}},"context":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"sentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveredAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","required":["type","occurredAt","attempt","reason"],"properties":{"type":{"type":"string"},"occurredAt":{"type":"string"},"attempt":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"example":{"object":"message","sid":"SM01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"status","direction":"outbound","from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":{"identifierType":"identifierType","value":"value"},"type":"type","priority":"priority","livemode":false,"providerMessageId":"providerMessageId","campaignSid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","conversationSid":"CO01J8Z3K4M5N6P7Q8R9S0T1V2W3","sentByPrincipal":"sentByPrincipal","pricing":{"category":"category","model":"model","customerChargeMinor":1,"currency":"USD"},"providerAccepted":false,"heldForQuality":false,"providerPaused":false,"attempt":1,"queuedReason":"queuedReason","readyAt":"readyAt","sendAt":"sendAt","deliverBefore":"deliverBefore","transport":"cloud_api","transportOptions":{},"cancelRequested":false,"unknownSince":"unknownSince","deletedByUser":false,"redacted":false,"contentUnreadable":false,"warnings":["warnings"],"duplicateDetected":false,"metadata":{},"tags":["tags"],"statusCallbackUrl":"statusCallbackUrl","createdAt":"createdAt","updatedAt":"updatedAt","sentAt":"sentAt","deliveredAt":"deliveredAt","readAt":"readAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:read"],"description":"Fetch one message with its current status, the provider's delivery timeline and, once settled, its charge.\n\nRequired scope: `messages:read`."},"delete":{"summary":"Redact and schedule removal of a message","tags":["messages"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SM","required":true,"description":"Message SID"}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:redact"],"description":"Required scope: `messages:redact`."}},"/v1/accounts/{AC}/templates":{"post":{"summary":"Create a template draft","tags":["templates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","language","category","parameterFormat"],"properties":{"wabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","description":"WABA SID; required when the account has multiple WABAs","type":"string"},"name":{"minLength":1,"maxLength":512,"type":"string"},"language":{"minLength":2,"maxLength":16,"type":"string"},"category":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["UTILITY"]},{"type":"string","enum":["AUTHENTICATION"]}]},"parameterFormat":{"anyOf":[{"type":"string","enum":["NAMED"]},{"type":"string","enum":["POSITIONAL"]}]},"components":{"maxItems":20,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"messageSendTtlSeconds":{"minimum":30,"maximum":2592000,"type":"integer"},"codeExpirationMinutes":{"minimum":1,"maximum":90,"type":"integer"},"headerMediaHandle":{"minLength":3,"maxLength":2048,"pattern":"^[0-9]+:\\S+$","description":"Handle returned by POST /media/uploads for a media template header (§32.3).","type":"string"},"source":{"anyOf":[{"type":"string","enum":["custom"]},{"type":"string","enum":["meta_library"]}]},"libraryTemplateName":{"maxLength":256,"type":"string"}}},"example":{"name":"order_ready","language":"en_US","category":"UTILITY","parameterFormat":"POSITIONAL","components":[{"type":"BODY","text":"Hi {{1}}, your {{2}} is ready for collection."}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"§13A.5 template resource","content":{"application/json":{"schema":{"description":"§13A.5 template resource","type":"object","required":["object","sid","name","language","category","parameterFormat","source","libraryTemplateName","metaTemplateId","status","statusReason","qualityScore","pacingState","pausedUntil","messageSendTtlSeconds","codeExpirationMinutes","buttonTypes","headerMediaHandle","components","usage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["template"]},"sid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"parameterFormat":{"type":"string"},"source":{"type":"string"},"libraryTemplateName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metaTemplateId":{"description":"Meta's template id once the template has been submitted; null for drafts.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"draft | submitted | pending | approved | rejected | paused | in_appeal | pending_deletion | deleted | limit_exceeded","type":"string"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"type":"string"},"pacingState":{"type":"string"},"pausedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"messageSendTtlSeconds":{"type":"integer"},"codeExpirationMinutes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"buttonTypes":{"type":"array","items":{"type":"string"}},"headerMediaHandle":{"description":"§32.3 handle attached to a media header; null when the header takes no asset.","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"usage":{"type":"object","required":["messages","activeCampaigns"],"properties":{"messages":{"type":"integer"},"activeCampaigns":{"type":"integer"}}},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"template","sid":"TM01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","language":"language","category":"category","parameterFormat":"parameterFormat","source":"source","libraryTemplateName":"libraryTemplateName","metaTemplateId":"metaTemplateId","status":"status","statusReason":"statusReason","qualityScore":"qualityScore","pacingState":"pacingState","pausedUntil":"pausedUntil","messageSendTtlSeconds":1,"codeExpirationMinutes":1,"buttonTypes":["buttonTypes"],"headerMediaHandle":"headerMediaHandle","components":[{}],"usage":{"messages":1,"activeCampaigns":1},"version":1,"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Create a template draft. Nothing is sent to Meta until you submit it for review.\n\nRequired scope: `templates:write`."},"get":{"summary":"List templates","tags":["templates"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"wabaSid","required":false,"description":"Filter by WABA SID"},{"schema":{"maxLength":512,"type":"string"},"in":"query","name":"name","required":false},{"schema":{"maxLength":16,"type":"string"},"in":"query","name":"language","required":false},{"schema":{"maxLength":32,"type":"string"},"in":"query","name":"status","required":false},{"schema":{"maxLength":16,"type":"string"},"in":"query","name":"category","required":false},{"schema":{"maxLength":16,"type":"string"},"in":"query","name":"qualityScore","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"updatedAfter","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"description":"§13A.5 template resource","type":"object","required":["object","sid","name","language","category","parameterFormat","source","libraryTemplateName","metaTemplateId","status","statusReason","qualityScore","pacingState","pausedUntil","messageSendTtlSeconds","codeExpirationMinutes","buttonTypes","headerMediaHandle","components","usage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["template"]},"sid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"parameterFormat":{"type":"string"},"source":{"type":"string"},"libraryTemplateName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metaTemplateId":{"description":"Meta's template id once the template has been submitted; null for drafts.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"draft | submitted | pending | approved | rejected | paused | in_appeal | pending_deletion | deleted | limit_exceeded","type":"string"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"type":"string"},"pacingState":{"type":"string"},"pausedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"messageSendTtlSeconds":{"type":"integer"},"codeExpirationMinutes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"buttonTypes":{"type":"array","items":{"type":"string"}},"headerMediaHandle":{"description":"§32.3 handle attached to a media header; null when the header takes no asset.","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"usage":{"type":"object","required":["messages","activeCampaigns"],"properties":{"messages":{"type":"integer"},"activeCampaigns":{"type":"integer"}}},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}},"example":{"data":[{"object":"template","sid":"TM01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","language":"language","category":"category","parameterFormat":"parameterFormat","source":"source","libraryTemplateName":"libraryTemplateName","metaTemplateId":"metaTemplateId","status":"status","statusReason":"statusReason","qualityScore":"qualityScore","pacingState":"pacingState","pausedUntil":"pausedUntil","messageSendTtlSeconds":1,"codeExpirationMinutes":1,"buttonTypes":["buttonTypes"],"headerMediaHandle":"headerMediaHandle","components":[{}],"usage":{"messages":1,"activeCampaigns":1},"version":1,"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}],"hasMore":false,"nextCursor":"nextCursor","dataAsOf":"dataAsOf"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"List message templates with their review status and quality.\n\nRequired scope: `templates:read`."}},"/v1/accounts/{AC}/templates/library":{"get":{"summary":"Browse the versioned Meta Template Library catalog","tags":["templates"],"parameters":[{"schema":{"maxLength":128,"type":"string"},"in":"query","name":"q","required":false},{"schema":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["UTILITY"]},{"type":"string","enum":["AUTHENTICATION"]}]},"in":"query","name":"category","required":false},{"schema":{"maxLength":16,"type":"string"},"in":"query","name":"language","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/templates/{TM}":{"get":{"summary":"Fetch a template","tags":["templates"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"}],"responses":{"200":{"description":"§13A.5 template resource","content":{"application/json":{"schema":{"description":"§13A.5 template resource","type":"object","required":["object","sid","name","language","category","parameterFormat","source","libraryTemplateName","metaTemplateId","status","statusReason","qualityScore","pacingState","pausedUntil","messageSendTtlSeconds","codeExpirationMinutes","buttonTypes","headerMediaHandle","components","usage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["template"]},"sid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"parameterFormat":{"type":"string"},"source":{"type":"string"},"libraryTemplateName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metaTemplateId":{"description":"Meta's template id once the template has been submitted; null for drafts.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"draft | submitted | pending | approved | rejected | paused | in_appeal | pending_deletion | deleted | limit_exceeded","type":"string"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"type":"string"},"pacingState":{"type":"string"},"pausedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"messageSendTtlSeconds":{"type":"integer"},"codeExpirationMinutes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"buttonTypes":{"type":"array","items":{"type":"string"}},"headerMediaHandle":{"description":"§32.3 handle attached to a media header; null when the header takes no asset.","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"usage":{"type":"object","required":["messages","activeCampaigns"],"properties":{"messages":{"type":"integer"},"activeCampaigns":{"type":"integer"}}},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"template","sid":"TM01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","language":"language","category":"category","parameterFormat":"parameterFormat","source":"source","libraryTemplateName":"libraryTemplateName","metaTemplateId":"metaTemplateId","status":"status","statusReason":"statusReason","qualityScore":"qualityScore","pacingState":"pacingState","pausedUntil":"pausedUntil","messageSendTtlSeconds":1,"codeExpirationMinutes":1,"buttonTypes":["buttonTypes"],"headerMediaHandle":"headerMediaHandle","components":[{}],"usage":{"messages":1,"activeCampaigns":1},"version":1,"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Fetch one template with its components, status and rejection reason, if any.\n\nRequired scope: `templates:read`."},"patch":{"summary":"Edit a draft or provider-backed template","tags":["templates"],"description":"Edit a draft, or a template already with Meta where Meta allows the change.\n\nRequired scope: `templates:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"components":{"maxItems":20,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"messageSendTtlSeconds":{"minimum":30,"maximum":2592000,"type":"integer"},"codeExpirationMinutes":{"minimum":1,"maximum":90,"type":"integer"},"headerMediaHandle":{"minLength":3,"maxLength":2048,"pattern":"^[0-9]+:\\S+$","description":"Handle returned by POST /media/uploads for a media template header (§32.3).","type":"string"},"category":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["UTILITY"]},{"type":"string","enum":["AUTHENTICATION"]}]}}},"example":{"components":[{"type":"BODY","text":"Hi {{1}}, your {{2}} is ready. Show this message."}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"§13A.5 template resource","content":{"application/json":{"schema":{"description":"§13A.5 template resource","type":"object","required":["object","sid","name","language","category","parameterFormat","source","libraryTemplateName","metaTemplateId","status","statusReason","qualityScore","pacingState","pausedUntil","messageSendTtlSeconds","codeExpirationMinutes","buttonTypes","headerMediaHandle","components","usage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["template"]},"sid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"parameterFormat":{"type":"string"},"source":{"type":"string"},"libraryTemplateName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metaTemplateId":{"description":"Meta's template id once the template has been submitted; null for drafts.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"draft | submitted | pending | approved | rejected | paused | in_appeal | pending_deletion | deleted | limit_exceeded","type":"string"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"type":"string"},"pacingState":{"type":"string"},"pausedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"messageSendTtlSeconds":{"type":"integer"},"codeExpirationMinutes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"buttonTypes":{"type":"array","items":{"type":"string"}},"headerMediaHandle":{"description":"§32.3 handle attached to a media header; null when the header takes no asset.","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"usage":{"type":"object","required":["messages","activeCampaigns"],"properties":{"messages":{"type":"integer"},"activeCampaigns":{"type":"integer"}}},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"template","sid":"TM01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","language":"language","category":"category","parameterFormat":"parameterFormat","source":"source","libraryTemplateName":"libraryTemplateName","metaTemplateId":"metaTemplateId","status":"status","statusReason":"statusReason","qualityScore":"qualityScore","pacingState":"pacingState","pausedUntil":"pausedUntil","messageSendTtlSeconds":1,"codeExpirationMinutes":1,"buttonTypes":["buttonTypes"],"headerMediaHandle":"headerMediaHandle","components":[{}],"usage":{"messages":1,"activeCampaigns":1},"version":1,"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"]},"delete":{"summary":"Delete a template by name","tags":["templates"],"description":"Delete a template. Meta deletes every language of the same name, and the name cannot be reused for 30 days.\n\nRequired scope: `templates:write`.","parameters":[{"schema":{"maxLength":16,"type":"string"},"in":"query","name":"language","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"]}},"/v1/accounts/{AC}/templates/{TM}/history":{"get":{"summary":"Fetch template category, version, and appeal history","tags":["templates"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"appealCursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["versions","appeals","affectedCampaigns","hasMore","nextCursor","appealsHaveMore","nextAppealCursor","dataAsOf"],"properties":{"versions":{"type":"array","items":{"type":"object","required":["version","category","changeSource","occurredAt"],"properties":{"version":{"type":"integer"},"category":{"type":"string"},"changeSource":{"type":"string"},"occurredAt":{"format":"date-time","type":"string"}}}},"appeals":{"type":"array","items":{"type":"object","required":["state","previousCategory","newCategory","justification","supportCaseReference","outcome","submittedAt","outcomeAt"],"properties":{"state":{"type":"string"},"previousCategory":{"anyOf":[{"type":"string"},{"type":"null"}]},"newCategory":{"anyOf":[{"type":"string"},{"type":"null"}]},"justification":{"type":"string"},"supportCaseReference":{"type":"string"},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}]},"submittedAt":{"format":"date-time","type":"string"},"outcomeAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}},"affectedCampaigns":{"type":"integer"},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"appealsHaveMore":{"type":"boolean"},"nextAppealCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/templates/{TM}/submit":{"post":{"summary":"Submit a template for review","tags":["templates"],"description":"Submit a draft to Meta for review. The result arrives as a `template.*` webhook event.\n\nRequired scope: `templates:write`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"]}},"/v1/accounts/{AC}/templates/{TM}/duplicate":{"post":{"summary":"Duplicate a template as a new draft while retaining its origin","tags":["templates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name"],"properties":{"name":{"minLength":1,"maxLength":512,"type":"string"},"language":{"minLength":2,"maxLength":16,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"§13A.5 template resource","content":{"application/json":{"schema":{"description":"§13A.5 template resource","type":"object","required":["object","sid","name","language","category","parameterFormat","source","libraryTemplateName","metaTemplateId","status","statusReason","qualityScore","pacingState","pausedUntil","messageSendTtlSeconds","codeExpirationMinutes","buttonTypes","headerMediaHandle","components","usage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["template"]},"sid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"parameterFormat":{"type":"string"},"source":{"type":"string"},"libraryTemplateName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metaTemplateId":{"description":"Meta's template id once the template has been submitted; null for drafts.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"draft | submitted | pending | approved | rejected | paused | in_appeal | pending_deletion | deleted | limit_exceeded","type":"string"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"type":"string"},"pacingState":{"type":"string"},"pausedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"messageSendTtlSeconds":{"type":"integer"},"codeExpirationMinutes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"buttonTypes":{"type":"array","items":{"type":"string"}},"headerMediaHandle":{"description":"§32.3 handle attached to a media header; null when the header takes no asset.","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"usage":{"type":"object","required":["messages","activeCampaigns"],"properties":{"messages":{"type":"integer"},"activeCampaigns":{"type":"integer"}}},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/templates/reconcile":{"post":{"summary":"Reconcile the complete local template projection with Meta","tags":["templates"],"parameters":[{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"wabaSid","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["queued","wabaSid"],"properties":{"queued":{"type":"boolean","enum":[true]},"wabaSid":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/templates/{TM}/appeal":{"post":{"summary":"Record an approved-template category appeal submitted through Meta Business Support","tags":["templates"],"description":"Records the confirmed external case for the latest Meta category change and projects IN_APPEAL.\n\nRequired scope: `templates:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["confirmedSubmittedToMeta","supportCaseReference","note"],"properties":{"confirmedSubmittedToMeta":{"type":"boolean","enum":[true]},"supportCaseReference":{"minLength":3,"maxLength":256,"type":"string"},"note":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"TM","required":true,"description":"Template SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"§13A.5 template resource","content":{"application/json":{"schema":{"description":"§13A.5 template resource","type":"object","required":["object","sid","name","language","category","parameterFormat","source","libraryTemplateName","metaTemplateId","status","statusReason","qualityScore","pacingState","pausedUntil","messageSendTtlSeconds","codeExpirationMinutes","buttonTypes","headerMediaHandle","components","usage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["template"]},"sid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"parameterFormat":{"type":"string"},"source":{"type":"string"},"libraryTemplateName":{"anyOf":[{"type":"string"},{"type":"null"}]},"metaTemplateId":{"description":"Meta's template id once the template has been submitted; null for drafts.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"draft | submitted | pending | approved | rejected | paused | in_appeal | pending_deletion | deleted | limit_exceeded","type":"string"},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"type":"string"},"pacingState":{"type":"string"},"pausedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"messageSendTtlSeconds":{"type":"integer"},"codeExpirationMinutes":{"anyOf":[{"type":"integer"},{"type":"null"}]},"buttonTypes":{"type":"array","items":{"type":"string"}},"headerMediaHandle":{"description":"§32.3 handle attached to a media header; null when the header takes no asset.","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"usage":{"type":"object","required":["messages","activeCampaigns"],"properties":{"messages":{"type":"integer"},"activeCampaigns":{"type":"integer"}}},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"]}},"/v1/accounts/{AC}/contents":{"post":{"summary":"Create reusable content","tags":["contents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","defaultLanguage","bindings"],"properties":{"name":{"minLength":1,"maxLength":256,"type":"string"},"defaultLanguage":{"minLength":2,"maxLength":16,"type":"string"},"bindings":{"minItems":1,"maxItems":100,"type":"array","items":{"additionalProperties":false,"type":"object","required":["templateSid","language"],"properties":{"templateSid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","description":"Template SID","type":"string"},"language":{"minLength":2,"maxLength":16,"type":"string"}}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","name","defaultLanguage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["content"]},"sid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","description":"Content SID","type":"string"},"name":{"type":"string"},"defaultLanguage":{"type":"string"},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."},"get":{"summary":"List reusable content resources","tags":["contents"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["object","sid","name","defaultLanguage","version","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["content"]},"sid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","description":"Content SID","type":"string"},"name":{"type":"string"},"defaultLanguage":{"type":"string"},"version":{"type":"integer"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/contents/{HX}/render":{"post":{"summary":"Render a content preview","tags":["contents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["variables"],"properties":{"variables":{"type":"object","additionalProperties":{"maxLength":4096,"type":"string"}},"language":{"minLength":2,"maxLength":16,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"HX","required":true,"description":"Content SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","contentSid","language","preview","template"],"properties":{"object":{"type":"string","enum":["content_preview"]},"contentSid":{"type":"string"},"language":{"type":"string"},"preview":{},"template":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/contents/{HX}/approvals":{"get":{"summary":"List per-language content approvals","tags":["contents"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"HX","required":true,"description":"Content SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/flows":{"post":{"summary":"Create a local Flow draft","tags":["flows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["wabaSid","name","categories","definition"],"properties":{"wabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"minLength":1,"maxLength":256,"type":"string"},"categories":{"maxItems":20,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"format":"uri","maxLength":2048,"type":"string"},"endpointMode":{"anyOf":[{"type":"string","enum":["gateway"]},{"type":"string","enum":["direct"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","categories","version","status","definition","endpointUri","endpointMode","endpointHealth","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["flow"]},"sid":{"type":"string"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"status":{"type":"string"},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"endpointMode":{"type":"string"},"endpointHealth":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"endpointSecret":{"description":"Returned once when created.","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."},"get":{"summary":"List Flows","tags":["flows"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"maxLength":32,"type":"string"},"in":"query","name":"status","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["object","sid","name","categories","version","status","definition","endpointUri","endpointMode","endpointHealth","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["flow"]},"sid":{"type":"string"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"status":{"type":"string"},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"endpointMode":{"type":"string"},"endpointHealth":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"endpointSecret":{"description":"Returned once when created.","type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/flows/{FL}":{"get":{"summary":"Fetch a Flow","tags":["flows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","categories","version","status","definition","endpointUri","endpointMode","endpointHealth","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["flow"]},"sid":{"type":"string"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"status":{"type":"string"},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"endpointMode":{"type":"string"},"endpointHealth":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"endpointSecret":{"description":"Returned once when created.","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."},"patch":{"summary":"Edit a Flow draft","tags":["flows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"name":{"minLength":1,"maxLength":256,"type":"string"},"categories":{"maxItems":20,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"format":"uri","maxLength":2048,"type":"string"},"endpointMode":{"anyOf":[{"type":"string","enum":["gateway"]},{"type":"string","enum":["direct"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","categories","version","status","definition","endpointUri","endpointMode","endpointHealth","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["flow"]},"sid":{"type":"string"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"status":{"type":"string"},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"endpointMode":{"type":"string"},"endpointHealth":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"endpointSecret":{"description":"Returned once when created.","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/flows/{FL}/readiness":{"get":{"summary":"Flow endpoint and per-sender encryption-key readiness","tags":["flows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","flowSid","endpointHealth","lastPingAt","lastDataExchangeAt","endpointFailureCount","endpointThrottledUntil","senders"],"properties":{"object":{"type":"string","enum":["flow_readiness"]},"flowSid":{"type":"string"},"endpointHealth":{"type":"string"},"lastPingAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastDataExchangeAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"endpointFailureCount":{"type":"integer"},"endpointThrottledUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"senders":{"type":"array","items":{"type":"object","required":["senderSid","displayName","keyState"],"properties":{"senderSid":{"type":"string"},"displayName":{"type":"string"},"keyState":{"type":"string"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/flows/{FL}/history":{"get":{"summary":"List immutable Flow definition versions","tags":["flows"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:read"],"description":"Required scope: `templates:read`."}},"/v1/accounts/{AC}/flows/{FL}/clone":{"post":{"summary":"Clone a Flow definition into a new editable draft","tags":["flows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name"],"properties":{"name":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","categories","version","status","definition","endpointUri","endpointMode","endpointHealth","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["flow"]},"sid":{"type":"string"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"status":{"type":"string"},"definition":{"additionalProperties":true,"type":"object","properties":{}},"endpointUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"endpointMode":{"type":"string"},"endpointHealth":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"endpointSecret":{"description":"Returned once when created.","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/flows/{FL}/endpoint/secret/rotate":{"post":{"summary":"Rotate the plaintext-signing secret for a gateway Flow endpoint","tags":["flows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","flowSid","secret"],"properties":{"object":{"type":"string","enum":["flow_endpoint_secret"]},"flowSid":{"type":"string"},"secret":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/flows/{FL}/publish":{"post":{"summary":"Publish a Flow through Meta","tags":["flows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/flows/{FL}/deprecate":{"post":{"summary":"Deprecate a Flow through Meta","tags":["flows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"FL","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["templates:write"],"description":"Required scope: `templates:write`."}},"/v1/accounts/{AC}/contacts":{"post":{"summary":"Resolve or create a contact by identifier","tags":["contacts"],"description":"Find the contact with this identifier, or create it. Calling it twice with the same number returns the same contact.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["identifiers"],"properties":{"identifiers":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"minLength":1,"maxLength":256,"type":"string"},"scopeRef":{"maxLength":64,"type":"string"}}}},"defaultCountry":{"pattern":"^[A-Za-z]{2}$","type":"string"},"displayName":{"maxLength":128,"type":"string"},"locale":{"maxLength":16,"type":"string"},"timezone":{"maxLength":64,"type":"string"},"attributes":{"type":"object","additionalProperties":{}}}},"example":{"identifiers":[{"type":"phone_e164","value":"+14155550123"}],"displayName":"Ada Lovelace","locale":"en-GB","attributes":{"tier":"gold"}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","displayName","locale","timezone","attributes","state","identifiers","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["contact"]},"sid":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"attributes":{"type":"object","additionalProperties":{}},"state":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","required":["type","value","scopeRef","primary","unreadable"],"properties":{"type":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"unreadable":{"type":"boolean"}}}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"contact","sid":"sid","displayName":"displayName","locale":"locale","timezone":"timezone","attributes":{},"state":"state","identifiers":[{"type":"phone_e164","value":"value","scopeRef":"scopeRef","primary":false,"unreadable":false}],"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","displayName","locale","timezone","attributes","state","identifiers","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["contact"]},"sid":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"attributes":{"type":"object","additionalProperties":{}},"state":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","required":["type","value","scopeRef","primary","unreadable"],"properties":{"type":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"unreadable":{"type":"boolean"}}}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]},"get":{"summary":"List contacts or find one by identifier","tags":["contacts"],"parameters":[{"schema":{"minLength":1,"maxLength":128,"type":"string"},"in":"query","name":"q","required":false},{"schema":{"minLength":1,"maxLength":256,"type":"string"},"in":"query","name":"identifier","required":false},{"schema":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"in":"query","name":"identifierType","required":false},{"schema":{"maxLength":64,"type":"string"},"in":"query","name":"scopeRef","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","displayName","locale","timezone","attributes","state","identifiers","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["contact"]},"sid":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"attributes":{"type":"object","additionalProperties":{}},"state":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","required":["type","value","scopeRef","primary","unreadable"],"properties":{"type":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"unreadable":{"type":"boolean"}}}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}},"example":{"data":[{"object":"contact","sid":"sid","displayName":"displayName","locale":"locale","timezone":"timezone","attributes":{},"state":"state","identifiers":[{"type":"phone_e164","value":"value","scopeRef":"scopeRef","primary":false,"unreadable":false}],"createdAt":"createdAt","updatedAt":"updatedAt"}],"hasMore":false,"nextCursor":"nextCursor","dataAsOf":"dataAsOf"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"List contacts, or find one by phone number or WhatsApp user ID with the identifier filters.\n\nRequired scope: `contacts:read`."}},"/v1/accounts/{AC}/contacts/{CT}":{"get":{"summary":"Fetch a contact","tags":["contacts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","displayName","locale","timezone","attributes","state","identifiers","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["contact"]},"sid":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"attributes":{"type":"object","additionalProperties":{}},"state":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","required":["type","value","scopeRef","primary","unreadable"],"properties":{"type":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"unreadable":{"type":"boolean"}}}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"contact","sid":"sid","displayName":"displayName","locale":"locale","timezone":"timezone","attributes":{},"state":"state","identifiers":[{"type":"phone_e164","value":"value","scopeRef":"scopeRef","primary":false,"unreadable":false}],"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Fetch one contact with its identifiers, attributes and consent summary.\n\nRequired scope: `contacts:read`."},"patch":{"summary":"Update a contact's profile and attributes","tags":["contacts"],"description":"Update a contact's name, locale, time zone or attributes. Send `expectedUpdatedAt` to refuse the change if someone else edited the contact first.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"displayName":{"anyOf":[{"type":"null"},{"maxLength":128,"type":"string"}]},"locale":{"anyOf":[{"type":"null"},{"maxLength":16,"type":"string"}]},"timezone":{"anyOf":[{"type":"null"},{"maxLength":64,"type":"string"}]},"attributes":{"type":"object","additionalProperties":{}},"expectedUpdatedAt":{"format":"date-time","type":"string"}}},"example":{"displayName":"Ada King","attributes":{"tier":"platinum"}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","displayName","locale","timezone","attributes","state","identifiers","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["contact"]},"sid":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"attributes":{"type":"object","additionalProperties":{}},"state":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","required":["type","value","scopeRef","primary","unreadable"],"properties":{"type":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"unreadable":{"type":"boolean"}}}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"contact","sid":"sid","displayName":"displayName","locale":"locale","timezone":"timezone","attributes":{},"state":"state","identifiers":[{"type":"phone_e164","value":"value","scopeRef":"scopeRef","primary":false,"unreadable":false}],"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]}},"/v1/accounts/{AC}/senders/{WA}/contacts/{CT}/window":{"get":{"summary":"Get the durable service-window state for a sender/contact pair (§31)","tags":["contacts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","senderSid","contactSid","open","serviceWindowExpiresAt","freeEntryPointOpen","freeEntryPointExpiresAt"],"properties":{"object":{"type":"string","enum":["service_window"]},"senderSid":{"type":"string"},"contactSid":{"type":"string"},"open":{"type":"boolean"},"serviceWindowExpiresAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"freeEntryPointOpen":{"type":"boolean"},"freeEntryPointExpiresAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."}},"/v1/accounts/{AC}/contacts/{CT}/consents":{"post":{"summary":"Record a consent event (append-only, §102.1)","tags":["contacts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["purpose","status","source"],"properties":{"purpose":{"anyOf":[{"type":"string","enum":["TRANSACTIONAL"]},{"type":"string","enum":["AUTHENTICATION"]},{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["SUPPORT"]}]},"status":{"anyOf":[{"type":"string","enum":["OPTED_IN"]},{"type":"string","enum":["OPTED_OUT"]},{"type":"string","enum":["UNKNOWN"]},{"type":"string","enum":["REVOKED"]},{"type":"string","enum":["EXPIRED"]}]},"source":{"anyOf":[{"type":"string","enum":["API"]},{"type":"string","enum":["IMPORT"]},{"type":"string","enum":["KEYWORD"]},{"type":"string","enum":["FORM"]},{"type":"string","enum":["PROVIDER"]},{"type":"string","enum":["DASHBOARD"]}]},"evidenceRef":{"maxLength":512,"type":"string"},"evidence":{"additionalProperties":false,"type":"object","properties":{"sourcePage":{"maxLength":2048,"type":"string"},"application":{"maxLength":128,"type":"string"},"wording":{"maxLength":4096,"type":"string"},"wordingVersion":{"maxLength":128,"type":"string"},"campaignRef":{"maxLength":128,"type":"string"},"proofRef":{"maxLength":512,"type":"string"},"capturedAt":{"format":"date-time","type":"string"},"reason":{"minLength":1,"maxLength":1000,"type":"string"},"withdrawnAt":{"format":"date-time","type":"string"},"supersedesConsentSid":{"pattern":"^CV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"reOptIn":{"type":"boolean"}}},"expiresAt":{"format":"date-time","type":"string"}}},"example":{"purpose":"MARKETING","status":"OPTED_IN","source":"FORM","evidence":{"capturedAt":"2026-09-26T09:30:00.000Z","sourcePage":"https://example.com/signup","wording":"Send me offers on WhatsApp"}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["recorded"],"properties":{"recorded":{"type":"boolean"}}},"example":{"recorded":false}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Record that a contact opted in or out for a purpose. Consent history is append-only: a new record supersedes, never overwrites.\n\nRequired scope: `contacts:write`."},"get":{"summary":"Full consent history (§102.2)","tags":["contacts"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","purpose","status","source","evidenceRef","evidence","capturedAt","expiresAt","withdrawnAt","actor"],"properties":{"object":{"type":"string","enum":["consent"]},"sid":{"type":"string"},"purpose":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"},"evidenceRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"evidence":{"type":"object","additionalProperties":{}},"capturedAt":{"type":"string"},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"withdrawnAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"actor":{"anyOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string"},"ref":{"type":"string"}}},{"type":"null"}]}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/contacts/{CT}/suppressions":{"post":{"summary":"Add a suppression (§102.3)","tags":["contacts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","scope","source"],"properties":{"reason":{"anyOf":[{"type":"string","enum":["CUSTOMER_OPT_OUT"]},{"type":"string","enum":["PROVIDER_MARKETING_OPT_OUT"]},{"type":"string","enum":["KEYWORD_OPT_OUT"]},{"type":"string","enum":["COMPLAINT"]},{"type":"string","enum":["LEGAL_SUPPRESSION"]},{"type":"string","enum":["TENANT_BLOCKLIST"]},{"type":"string","enum":["RISK_BLOCK"]}]},"scope":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["ALL"]}]},"source":{"minLength":1,"maxLength":64,"type":"string"},"expiresAt":{"format":"date-time","type":"string"},"mirrorToProvider":{"type":"boolean"},"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"example":{"reason":"CUSTOMER_OPT_OUT","scope":"MARKETING","source":"crm"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["sid","providerBlockState"],"properties":{"sid":{"type":"string"},"providerBlockState":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"sid":"sid","providerBlockState":"providerBlockState"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Stop messages to a contact, for marketing only or for everything. Suppressed contacts are refused at send time.\n\nRequired scope: `contacts:write`."},"get":{"summary":"List suppression history for a contact","tags":["contacts"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","contactSid","reason","scope","source","active","expiresAt","removedAt","createdAt","mirrorToProvider","providerBlockState","addedBy","removedBy","removalReason"],"properties":{"object":{"type":"string","enum":["suppression"]},"sid":{"type":"string"},"contactSid":{"type":"string"},"reason":{"type":"string"},"scope":{"type":"string"},"source":{"type":"string"},"active":{"type":"boolean"},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"removedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"mirrorToProvider":{"type":"boolean"},"providerBlockState":{"anyOf":[{"type":"string"},{"type":"null"}]},"addedBy":{"anyOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string"},"ref":{"type":"string"}}},{"type":"null"}]},"removedBy":{"anyOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string"},"ref":{"type":"string"}}},{"type":"null"}]},"removalReason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/contacts/{CT}/suppressions/{SU}":{"delete":{"summary":"Remove a suppression (a state change, never a delete of history, §28.6)","tags":["contacts"],"parameters":[{"schema":{"minLength":1,"maxLength":500,"type":"string"},"in":"query","name":"reason","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true},{"schema":{"pattern":"^SU[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SU","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["removed"],"properties":{"removed":{"type":"boolean"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/suppressions":{"post":{"summary":"Suppress a contact by SID or by identifier (§13A.7, §102.3)","tags":["contacts"],"description":"Addressed with exactly one of `contactSid` or `identifier`. An identifier that this account has never seen resolves-or-creates the contact, so a suppression captured before the first message still holds when that message is attempted.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","scope"],"properties":{"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"identifier":{"minLength":1,"maxLength":256,"type":"string"},"identifierType":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"scopeRef":{"maxLength":64,"type":"string"},"reason":{"anyOf":[{"type":"string","enum":["CUSTOMER_OPT_OUT"]},{"type":"string","enum":["PROVIDER_MARKETING_OPT_OUT"]},{"type":"string","enum":["KEYWORD_OPT_OUT"]},{"type":"string","enum":["COMPLAINT"]},{"type":"string","enum":["LEGAL_SUPPRESSION"]},{"type":"string","enum":["TENANT_BLOCKLIST"]},{"type":"string","enum":["RISK_BLOCK"]}]},"scope":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["ALL"]}]},"source":{"minLength":1,"maxLength":64,"type":"string"},"expiresAt":{"format":"date-time","type":"string"},"mirrorToProvider":{"type":"boolean"},"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["sid","contactSid","providerBlockState"],"properties":{"sid":{"type":"string"},"contactSid":{"type":"string"},"providerBlockState":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]},"delete":{"summary":"Lift suppressions for a contact addressed by SID or identifier (§13A.7)","tags":["contacts"],"description":"Removal is a state change, never a delete of history (§28.6): each affected row keeps its record and emits `suppression.removed`. Narrow with `suppressionSid` or `scope`.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"identifier":{"minLength":1,"maxLength":256,"type":"string"},"identifierType":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"scopeRef":{"maxLength":64,"type":"string"},"suppressionSid":{"pattern":"^SU[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"scope":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["ALL"]}]},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["removed","contactSid","suppressionSids"],"properties":{"removed":{"type":"integer"},"contactSid":{"type":"string"},"suppressionSids":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]},"get":{"summary":"List account suppressions with filters (§13A.7)","tags":["contacts"],"description":"Account-wide by default; filter by contact, identifier, reason or scope. `active=false` returns the full history including lifted and expired rows.\n\nRequired scope: `contacts:read`.","parameters":[{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"contactSid","required":false},{"schema":{"minLength":1,"maxLength":256,"type":"string"},"in":"query","name":"identifier","required":false},{"schema":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"in":"query","name":"identifierType","required":false},{"schema":{"maxLength":64,"type":"string"},"in":"query","name":"scopeRef","required":false},{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"query","name":"reason","required":false},{"schema":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["ALL"]}]},"in":"query","name":"scope","required":false},{"schema":{"type":"boolean"},"in":"query","name":"active","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","contactSid","reason","scope","source","active","expiresAt","removedAt","createdAt","mirrorToProvider","providerBlockState","addedBy","removedBy","removalReason"],"properties":{"object":{"type":"string","enum":["suppression"]},"sid":{"type":"string"},"contactSid":{"type":"string"},"reason":{"type":"string"},"scope":{"type":"string"},"source":{"type":"string"},"active":{"type":"boolean"},"expiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"removedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"mirrorToProvider":{"type":"boolean"},"providerBlockState":{"anyOf":[{"type":"string"},{"type":"null"}]},"addedBy":{"anyOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string"},"ref":{"type":"string"}}},{"type":"null"}]},"removedBy":{"anyOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string"},"ref":{"type":"string"}}},{"type":"null"}]},"removalReason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"]}},"/v1/accounts/{AC}/contacts/merges":{"get":{"summary":"List reversible contact merge history","tags":["contacts"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/contacts/merges/{ID}":{"get":{"summary":"Get contact merge recovery detail","tags":["contacts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"ID","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/authorizations":{"post":{"summary":"Record the customer's instruction for an action taken on their behalf (§7.2)","tags":["contacts"],"description":"Meta's Tech Provider terms allow a provider to act only on the customer's instruction. This records one: who gave it, for which task, in their own words. It is written to the append-only audit chain rather than a table of its own, because what an authorisation needs is exactly what that chain already guarantees — attributable, timestamped, and not quietly editable afterwards by either side.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["task","instruction","resourceRef"],"properties":{"task":{"anyOf":[{"type":"string","enum":["DISPLAY_NAME_SUBMISSION"]},{"type":"string","enum":["OFFICIAL_BUSINESS_ACCOUNT_APPLICATION"]},{"type":"string","enum":["TEMPLATE_SUBMISSION"]},{"type":"string","enum":["TEMPLATE_APPEAL"]}]},"instruction":{"minLength":10,"maxLength":2000,"type":"string"},"resourceRef":{"minLength":2,"maxLength":64,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]}},"/v1/accounts/{AC}/consent-coverage":{"get":{"summary":"How much of this account's audience you may lawfully message (§102)","tags":["contacts"],"description":"Contacts counted by consent purpose and current status, with the number suppressed. Admission already refuses a marketing send without evidence; this is the same evidence read forward, so a business can see the size of the audience it may actually reach before it builds a campaign around one it may not.\n\nRequired scope: `contacts:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"]}},"/v1/accounts/{AC}/contacts/conflicts":{"get":{"summary":"List open contact identity conflicts (§101.4)","tags":["contacts"],"description":"An identifier that Meta or an import attached to a second contact in this account. Resolve by merging or dismissing.\n\nRequired scope: `contacts:read`.","parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"]}},"/v1/accounts/{AC}/contacts/conflicts/{ID}/resolve":{"post":{"summary":"Resolve an identity conflict by merging or dismissing it (§101.4)","tags":["contacts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["action"],"properties":{"action":{"anyOf":[{"type":"string","enum":["merge"]},{"type":"string","enum":["dismiss"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"ID","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["resolved","mergeId"],"properties":{"resolved":{"type":"boolean"},"mergeId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/contacts/{CT}/merge":{"post":{"summary":"Merge another contact into this one (§101.4)","tags":["contacts"],"description":"The named contact becomes MERGED with merged_into set; identifiers, consents, suppressions, conversation windows (max of both) and pending dispatch move to the surviving contact. Reversible for 30 days.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["mergeContactSid","reason"],"properties":{"mergeContactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"reason":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["mergeId","movedIdentifiers","movedConsents","movedSuppressions","movedConversations"],"properties":{"mergeId":{"type":"string"},"movedIdentifiers":{"type":"integer"},"movedConsents":{"type":"integer"},"movedSuppressions":{"type":"integer"},"movedConversations":{"type":"integer"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]}},"/v1/accounts/{AC}/contacts/merges/{ID}/revert":{"post":{"summary":"Reverse a contact merge within its 30-day window (§101.4)","tags":["contacts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"ID","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["reversed"],"properties":{"reversed":{"type":"boolean"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/managed-service/wabas/{WB}/exit":{"get":{"summary":"Get hosted WhatsApp exit progress","tags":["managed-service"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","id","state","caseRef","requestedAt","staffDueAt","overdue","dueCalendar","export","exportReceivedAt","numberMovedAt","closedAt","balance"],"properties":{"object":{"type":"string","enum":["managed_service_exit"]},"id":{"format":"uuid","type":"string"},"state":{"type":"string"},"caseRef":{"type":"string"},"requestedAt":{"format":"date-time","type":"string"},"staffDueAt":{"format":"date-time","type":"string"},"overdue":{"type":"boolean"},"dueCalendar":{"type":"string"},"export":{"anyOf":[{"type":"null"},{"type":"object","required":["sid","state","downloadedAt"],"properties":{"sid":{"type":"string"},"state":{"type":"string"},"downloadedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}]},"exportReceivedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"numberMovedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"closedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"balance":{"anyOf":[{"type":"object","required":["requested","sourceSubaccountId","caseRef","state","instruction","completedMinor","inProgressMinor","refusalReason","executions"],"properties":{"requested":{"type":"string"},"sourceSubaccountId":{"anyOf":[{"type":"string"},{"type":"null"}]},"caseRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["not_requested"]},{"type":"string","enum":["requested"]},{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["refused"]}]},"instruction":{"anyOf":[{"type":"null"},{"type":"object","required":["id","kind","requestFingerprint","sourceWalletId","destinationWalletId","amountMinor","currency","scale","requestedAt"],"properties":{"id":{"format":"uuid","type":"string"},"kind":{"anyOf":[{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]},"requestFingerprint":{"type":"string"},"sourceWalletId":{"format":"uuid","type":"string"},"destinationWalletId":{"anyOf":[{"type":"string"},{"type":"null"}]},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"currency":{"type":"string"},"scale":{"type":"integer"},"requestedAt":{"format":"date-time","type":"string"}}}]},"completedMinor":{"pattern":"^-?[0-9]+$","type":"string"},"inProgressMinor":{"pattern":"^-?[0-9]+$","type":"string"},"refusalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"executions":{"type":"array","items":{"type":"object","required":["id","kind","amountMinor","state","paymentRefundId","providerOperationId","providerRefundRef","sourceLedgerTransactionId","destinationLedgerTransactionId"],"properties":{"id":{"type":"string"},"kind":{"type":"string"},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"state":{"anyOf":[{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]}]},"paymentRefundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerOperationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerRefundRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"destinationLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},{"type":"object","required":["state","available","reason"],"properties":{"state":{"type":"string","enum":["unavailable"]},"available":{"type":"boolean","enum":[false]},"reason":{"type":"string","enum":["BILLING_READ_REQUIRED"]}}}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"x-response-scope":{"balance":"billing:read"},"description":"Required scope: `accounts:read`.\n\nFinancial balance details require billing:read. Otherwise balance contains only state=unavailable, available=false and reason=BILLING_READ_REQUIRED; no amounts, instructions or provider references are returned."},"post":{"summary":"Request a free hosted-number exit and complete customer-data export","tags":["managed-service"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":1,"type":"string"},"balanceRequest":{"anyOf":[{"type":"string","enum":["NONE"]},{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","id","state","caseRef","requestedAt","staffDueAt","overdue","dueCalendar","export","exportReceivedAt","numberMovedAt","closedAt","balance"],"properties":{"object":{"type":"string","enum":["managed_service_exit"]},"id":{"format":"uuid","type":"string"},"state":{"type":"string"},"caseRef":{"type":"string"},"requestedAt":{"format":"date-time","type":"string"},"staffDueAt":{"format":"date-time","type":"string"},"overdue":{"type":"boolean"},"dueCalendar":{"type":"string"},"export":{"anyOf":[{"type":"null"},{"type":"object","required":["sid","state","downloadedAt"],"properties":{"sid":{"type":"string"},"state":{"type":"string"},"downloadedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}]},"exportReceivedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"numberMovedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"closedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"balance":{"anyOf":[{"type":"object","required":["requested","sourceSubaccountId","caseRef","state","instruction","completedMinor","inProgressMinor","refusalReason","executions"],"properties":{"requested":{"type":"string"},"sourceSubaccountId":{"anyOf":[{"type":"string"},{"type":"null"}]},"caseRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["not_requested"]},{"type":"string","enum":["requested"]},{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["refused"]}]},"instruction":{"anyOf":[{"type":"null"},{"type":"object","required":["id","kind","requestFingerprint","sourceWalletId","destinationWalletId","amountMinor","currency","scale","requestedAt"],"properties":{"id":{"format":"uuid","type":"string"},"kind":{"anyOf":[{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]},"requestFingerprint":{"type":"string"},"sourceWalletId":{"format":"uuid","type":"string"},"destinationWalletId":{"anyOf":[{"type":"string"},{"type":"null"}]},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"currency":{"type":"string"},"scale":{"type":"integer"},"requestedAt":{"format":"date-time","type":"string"}}}]},"completedMinor":{"pattern":"^-?[0-9]+$","type":"string"},"inProgressMinor":{"pattern":"^-?[0-9]+$","type":"string"},"refusalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"executions":{"type":"array","items":{"type":"object","required":["id","kind","amountMinor","state","paymentRefundId","providerOperationId","providerRefundRef","sourceLedgerTransactionId","destinationLedgerTransactionId"],"properties":{"id":{"type":"string"},"kind":{"type":"string"},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"state":{"anyOf":[{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]}]},"paymentRefundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerOperationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerRefundRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"destinationLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},{"type":"object","required":["state","available","reason"],"properties":{"state":{"type":"string","enum":["unavailable"]},"available":{"type":"boolean","enum":[false]},"reason":{"type":"string","enum":["BILLING_READ_REQUIRED"]}}}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"x-required-scope-all":["accounts:write","exports:create","media:read","messages:read","contacts:read","contacts:read_identifiers","templates:read","conversations:read"],"x-conditional-required-scopes":[{"field":"balanceRequest","values":["REFUND","TRANSFER"],"all":["billing:write"]}],"description":"Required scope: `accounts:write`.\n\nAdditionally, every one of these scopes is required: `accounts:write`, `exports:create`, `media:read`, `messages:read`, `contacts:read`, `contacts:read_identifiers`, `templates:read`, `conversations:read`.\n\nWhen balanceRequest is REFUND or TRANSFER, billing:write is also required. NONE or an omitted balanceRequest does not require that financial instruction scope."}},"/v1/accounts/{AC}/managed-service/wabas/{WB}/exit/balance-request":{"post":{"summary":"Request a hosted-exit prepaid balance refund or transfer","tags":["managed-service"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["kind"],"properties":{"kind":{"anyOf":[{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]},"sourceWalletId":{"format":"uuid","type":"string"},"destinationWalletId":{"format":"uuid","type":"string"},"amountMinor":{"pattern":"^[1-9][0-9]{0,17}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","id","state","caseRef","requestedAt","staffDueAt","overdue","dueCalendar","export","exportReceivedAt","numberMovedAt","closedAt","balance"],"properties":{"object":{"type":"string","enum":["managed_service_exit"]},"id":{"format":"uuid","type":"string"},"state":{"type":"string"},"caseRef":{"type":"string"},"requestedAt":{"format":"date-time","type":"string"},"staffDueAt":{"format":"date-time","type":"string"},"overdue":{"type":"boolean"},"dueCalendar":{"type":"string"},"export":{"anyOf":[{"type":"null"},{"type":"object","required":["sid","state","downloadedAt"],"properties":{"sid":{"type":"string"},"state":{"type":"string"},"downloadedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}]},"exportReceivedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"numberMovedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"closedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"balance":{"anyOf":[{"type":"object","required":["requested","sourceSubaccountId","caseRef","state","instruction","completedMinor","inProgressMinor","refusalReason","executions"],"properties":{"requested":{"type":"string"},"sourceSubaccountId":{"anyOf":[{"type":"string"},{"type":"null"}]},"caseRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["not_requested"]},{"type":"string","enum":["requested"]},{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["refused"]}]},"instruction":{"anyOf":[{"type":"null"},{"type":"object","required":["id","kind","requestFingerprint","sourceWalletId","destinationWalletId","amountMinor","currency","scale","requestedAt"],"properties":{"id":{"format":"uuid","type":"string"},"kind":{"anyOf":[{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]},"requestFingerprint":{"type":"string"},"sourceWalletId":{"format":"uuid","type":"string"},"destinationWalletId":{"anyOf":[{"type":"string"},{"type":"null"}]},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"currency":{"type":"string"},"scale":{"type":"integer"},"requestedAt":{"format":"date-time","type":"string"}}}]},"completedMinor":{"pattern":"^-?[0-9]+$","type":"string"},"inProgressMinor":{"pattern":"^-?[0-9]+$","type":"string"},"refusalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"executions":{"type":"array","items":{"type":"object","required":["id","kind","amountMinor","state","paymentRefundId","providerOperationId","providerRefundRef","sourceLedgerTransactionId","destinationLedgerTransactionId"],"properties":{"id":{"type":"string"},"kind":{"type":"string"},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"state":{"anyOf":[{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]}]},"paymentRefundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerOperationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerRefundRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"destinationLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},{"type":"object","required":["state","available","reason"],"properties":{"state":{"type":"string","enum":["unavailable"]},"available":{"type":"boolean","enum":[false]},"reason":{"type":"string","enum":["BILLING_READ_REQUIRED"]}}}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"x-required-scope-all":["accounts:write","billing:write"],"description":"Required scope: `accounts:write`.\n\nAdditionally, every one of these scopes is required: `accounts:write`, `billing:write`."}},"/v1/accounts/{AC}/managed-service/wabas/{WB}/exit/export":{"post":{"summary":"Retry a failed or expired hosted-exit export","tags":["managed-service"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":1,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","id","state","caseRef","requestedAt","staffDueAt","overdue","dueCalendar","export","exportReceivedAt","numberMovedAt","closedAt","balance"],"properties":{"object":{"type":"string","enum":["managed_service_exit"]},"id":{"format":"uuid","type":"string"},"state":{"type":"string"},"caseRef":{"type":"string"},"requestedAt":{"format":"date-time","type":"string"},"staffDueAt":{"format":"date-time","type":"string"},"overdue":{"type":"boolean"},"dueCalendar":{"type":"string"},"export":{"anyOf":[{"type":"null"},{"type":"object","required":["sid","state","downloadedAt"],"properties":{"sid":{"type":"string"},"state":{"type":"string"},"downloadedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}]},"exportReceivedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"numberMovedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"closedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"balance":{"anyOf":[{"type":"object","required":["requested","sourceSubaccountId","caseRef","state","instruction","completedMinor","inProgressMinor","refusalReason","executions"],"properties":{"requested":{"type":"string"},"sourceSubaccountId":{"anyOf":[{"type":"string"},{"type":"null"}]},"caseRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["not_requested"]},{"type":"string","enum":["requested"]},{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["refused"]}]},"instruction":{"anyOf":[{"type":"null"},{"type":"object","required":["id","kind","requestFingerprint","sourceWalletId","destinationWalletId","amountMinor","currency","scale","requestedAt"],"properties":{"id":{"format":"uuid","type":"string"},"kind":{"anyOf":[{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]},"requestFingerprint":{"type":"string"},"sourceWalletId":{"format":"uuid","type":"string"},"destinationWalletId":{"anyOf":[{"type":"string"},{"type":"null"}]},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"currency":{"type":"string"},"scale":{"type":"integer"},"requestedAt":{"format":"date-time","type":"string"}}}]},"completedMinor":{"pattern":"^-?[0-9]+$","type":"string"},"inProgressMinor":{"pattern":"^-?[0-9]+$","type":"string"},"refusalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"executions":{"type":"array","items":{"type":"object","required":["id","kind","amountMinor","state","paymentRefundId","providerOperationId","providerRefundRef","sourceLedgerTransactionId","destinationLedgerTransactionId"],"properties":{"id":{"type":"string"},"kind":{"type":"string"},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"state":{"anyOf":[{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]}]},"paymentRefundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerOperationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerRefundRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"destinationLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},{"type":"object","required":["state","available","reason"],"properties":{"state":{"type":"string","enum":["unavailable"]},"available":{"type":"boolean","enum":[false]},"reason":{"type":"string","enum":["BILLING_READ_REQUIRED"]}}}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"x-required-scope-all":["accounts:write","exports:create","media:read","messages:read","contacts:read","contacts:read_identifiers","templates:read","conversations:read"],"description":"Required scope: `accounts:write`.\n\nAdditionally, every one of these scopes is required: `accounts:write`, `exports:create`, `media:read`, `messages:read`, `contacts:read`, `contacts:read_identifiers`, `templates:read`, `conversations:read`."}},"/v1/accounts/{AC}/managed-service/wabas/{WB}/exit/export-received":{"post":{"summary":"Confirm receipt of the hosted exit export","tags":["managed-service"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["received"],"properties":{"received":{"type":"boolean","enum":[true]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","id","state","caseRef","requestedAt","staffDueAt","overdue","dueCalendar","export","exportReceivedAt","numberMovedAt","closedAt","balance"],"properties":{"object":{"type":"string","enum":["managed_service_exit"]},"id":{"format":"uuid","type":"string"},"state":{"type":"string"},"caseRef":{"type":"string"},"requestedAt":{"format":"date-time","type":"string"},"staffDueAt":{"format":"date-time","type":"string"},"overdue":{"type":"boolean"},"dueCalendar":{"type":"string"},"export":{"anyOf":[{"type":"null"},{"type":"object","required":["sid","state","downloadedAt"],"properties":{"sid":{"type":"string"},"state":{"type":"string"},"downloadedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}]},"exportReceivedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"numberMovedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"closedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"balance":{"anyOf":[{"type":"object","required":["requested","sourceSubaccountId","caseRef","state","instruction","completedMinor","inProgressMinor","refusalReason","executions"],"properties":{"requested":{"type":"string"},"sourceSubaccountId":{"anyOf":[{"type":"string"},{"type":"null"}]},"caseRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["not_requested"]},{"type":"string","enum":["requested"]},{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["refused"]}]},"instruction":{"anyOf":[{"type":"null"},{"type":"object","required":["id","kind","requestFingerprint","sourceWalletId","destinationWalletId","amountMinor","currency","scale","requestedAt"],"properties":{"id":{"format":"uuid","type":"string"},"kind":{"anyOf":[{"type":"string","enum":["REFUND"]},{"type":"string","enum":["TRANSFER"]}]},"requestFingerprint":{"type":"string"},"sourceWalletId":{"format":"uuid","type":"string"},"destinationWalletId":{"anyOf":[{"type":"string"},{"type":"null"}]},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"currency":{"type":"string"},"scale":{"type":"integer"},"requestedAt":{"format":"date-time","type":"string"}}}]},"completedMinor":{"pattern":"^-?[0-9]+$","type":"string"},"inProgressMinor":{"pattern":"^-?[0-9]+$","type":"string"},"refusalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"executions":{"type":"array","items":{"type":"object","required":["id","kind","amountMinor","state","paymentRefundId","providerOperationId","providerRefundRef","sourceLedgerTransactionId","destinationLedgerTransactionId"],"properties":{"id":{"type":"string"},"kind":{"type":"string"},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"state":{"anyOf":[{"type":"string","enum":["in_progress"]},{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]}]},"paymentRefundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerOperationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerRefundRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"destinationLedgerTransactionId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},{"type":"object","required":["state","available","reason"],"properties":{"state":{"type":"string","enum":["unavailable"]},"available":{"type":"boolean","enum":[false]},"reason":{"type":"string","enum":["BILLING_READ_REQUIRED"]}}}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"x-required-scope-all":["accounts:write","exports:create"],"description":"Required scope: `accounts:write`.\n\nAdditionally, every one of these scopes is required: `accounts:write`, `exports:create`."}},"/v1/accounts/{AC}/managed-service/containment":{"get":{"summary":"Read hosted portfolio containment and termination notices","tags":["managed-service"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["wabaSid","providerConnectionState","terminatedAt","hosting","notificationDueAt","notifiedAt"],"properties":{"wabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"providerConnectionState":{"type":"string"},"terminatedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"hosting":{"anyOf":[{"type":"string","enum":["terminated"]},{"type":"string","enum":["contained"]},{"type":"string","enum":["available"]}]},"notificationDueAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"notifiedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."}},"/v1/accounts/{AC}/service-context":{"get":{"summary":"Read setup intent and asset-specific service responsibilities","tags":["service-context"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["selectedOffer","services","mixed","hasMore","riskPolicyScope","hostedRiskAppliesAccountWide"],"properties":{"selectedOffer":{"anyOf":[{"anyOf":[{"type":"string","enum":["SELF_SERVICE"]},{"type":"string","enum":["ASSISTED"]},{"type":"string","enum":["MANAGED"]}]},{"type":"null"}]},"services":{"type":"array","items":{"type":"object","required":["wabaSid","subaccountSid","offer","state","setupReference","billingMode","portfolioOwnership"],"properties":{"wabaSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"subaccountSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"offer":{"anyOf":[{"type":"string","enum":["SELF_SERVICE"]},{"type":"string","enum":["ASSISTED"]},{"type":"string","enum":["MANAGED"]}]},"state":{"type":"string"},"setupReference":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingMode":{"anyOf":[{"type":"string"},{"type":"null"}]},"portfolioOwnership":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"mixed":{"type":"boolean"},"hasMore":{"type":"boolean"},"riskPolicyScope":{"type":"string","enum":["ACCOUNT"]},"hostedRiskAppliesAccountWide":{"type":"boolean"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"patch":{"summary":"Choose a setup offer without changing existing assets or service rights","tags":["service-context"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["selectedOffer"],"properties":{"selectedOffer":{"anyOf":[{"type":"string","enum":["SELF_SERVICE"]},{"type":"string","enum":["ASSISTED"]},{"type":"string","enum":["MANAGED"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["selectedOffer"],"properties":{"selectedOffer":{"anyOf":[{"type":"string","enum":["SELF_SERVICE"]},{"type":"string","enum":["ASSISTED"]},{"type":"string","enum":["MANAGED"]}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/managed-onboarding/quote":{"get":{"summary":"Read the current managed setup and number procurement quote","tags":["managed-onboarding"],"parameters":[{"schema":{"anyOf":[{"type":"string","enum":["PORT"]},{"type":"string","enum":["PURCHASE"]}]},"in":"query","name":"numberSource","required":true},{"schema":{"pattern":"^MA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"applicationSid","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."}},"/v1/accounts/{AC}/managed-onboarding/{MA}/accept-quote":{"post":{"summary":"Accept a current managed service quote before future approved work","tags":["managed-onboarding"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["acceptQuote","acceptedQuoteFingerprint","acceptedTermsVersion"],"properties":{"acceptQuote":{"type":"boolean"},"acceptedQuoteFingerprint":{"pattern":"^[0-9a-f]{64}$","type":"string"},"acceptedTermsVersion":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^MA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"MA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/managed-onboarding":{"post":{"summary":"Apply for a WhatsApp number hosted in ShipMsg's own Meta portfolio","tags":["managed-onboarding"],"description":"For businesses that cannot complete Meta's own verification. The customer supplies their business details and instructs us to act for them; we create the WhatsApp Business Account inside our portfolio and port or buy the number. One open application per account: submitting twice while waiting would produce two accounts for one business in the portfolio whose accumulation Meta sanctions.\n\nRequired scope: `accounts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["acceptQuote","acceptedQuoteFingerprint","acceptedTermsVersion","legalName","displayName","country","numberSource","instruction"],"properties":{"acceptQuote":{"type":"boolean"},"acceptedQuoteFingerprint":{"pattern":"^[0-9a-f]{64}$","type":"string"},"acceptedTermsVersion":{"minLength":1,"maxLength":128,"type":"string"},"legalName":{"minLength":2,"maxLength":200,"type":"string"},"displayName":{"minLength":2,"maxLength":200,"type":"string"},"country":{"pattern":"^[A-Z]{2}$","type":"string"},"website":{"maxLength":500,"type":"string"},"registrationNumber":{"maxLength":120,"type":"string"},"taxId":{"maxLength":120,"type":"string"},"registeredAddress":{"maxLength":500,"type":"string"},"representativeName":{"maxLength":200,"type":"string"},"representativeEmail":{"maxLength":320,"type":"string"},"numberSource":{"anyOf":[{"type":"string","enum":["PORT"]},{"type":"string","enum":["PURCHASE"]}]},"requestedNumber":{"pattern":"^\\+[1-9][0-9]{6,14}$","type":"string"},"instruction":{"minLength":20,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"]},"get":{"summary":"The state of this account's managed onboarding applications","tags":["managed-onboarding"],"description":"Returns what the customer submitted and where it has got to. The sealed business details are returned only to a principal on the account itself, and the response says plainly when they could not be opened rather than presenting an empty form as though nothing was ever entered.\n\nRequired scope: `accounts:read`.","parameters":[{"schema":{"pattern":"^MA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"applicationSid","required":false},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"wabaSid","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["serviceClosed","serviceState"],"properties":{"serviceClosed":{"type":"boolean"},"serviceState":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"]}},"/v1/accounts/{AC}/managed-onboarding/{MA}/handover-phone":{"patch":{"summary":"Confirm the receiving phone for hosted service handover","tags":["managed-onboarding"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["handoverPhoneNumber"],"properties":{"handoverPhoneNumber":{"pattern":"^\\+[1-9][0-9]{6,14}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^MA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"MA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/managed-onboarding/{MA}":{"patch":{"summary":"Answer a hosted setup request for more information","tags":["managed-onboarding"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["information"],"properties":{"information":{"minLength":20,"maxLength":4000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^MA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"MA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."},"delete":{"summary":"Withdraw a hosted application before approval","tags":["managed-onboarding"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^MA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"MA","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/pricing":{"get":{"summary":"The published platform rate card","tags":["billing"],"description":"What ShipMsg charges per delivered message, by category, pricing type, transport, market and currency. Meta bills the business directly for the conversation itself; this fee is the entire ShipMsg charge. Public: no key is needed to read a price.","security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","serviceFees","model","currencies","rows","asOf"],"properties":{"object":{"type":"string","enum":["rate_card"]},"serviceFees":{"type":"array","items":{"type":"object","required":["kind","currency","amountMinor","scale"],"properties":{"kind":{"type":"string"},"currency":{"type":"string"},"amountMinor":{"type":"string"},"scale":{"type":"integer"}}}},"model":{"type":"string","enum":["META_DIRECT"]},"currencies":{"type":"array","items":{"type":"string"}},"rows":{"type":"array","items":{"type":"object","required":["category","pricingType","transport","market","currency","platformFeeMinor","scale","billableOn","effectiveFrom"],"properties":{"category":{"type":"string"},"pricingType":{"type":"string"},"transport":{"type":"string"},"market":{"type":"string"},"currency":{"type":"string"},"platformFeeMinor":{"type":"string"},"scale":{"type":"integer"},"billableOn":{"type":"string"},"effectiveFrom":{"type":"string"}}}},"asOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/accounts/{AC}/onboarding-cases":{"post":{"summary":"Ask ShipMsg to take you through Meta's setup (assisted onboarding)","tags":["onboarding-cases"],"description":"Opens an onboarding case. You keep your own WhatsApp Business Account and Meta bills you directly; we prepare and submit what a Tech Provider may, and track the rest. The one-time fee as it stands today is recorded on the case and charged when we take it on, from your live wallet. One open case per account scope.\n\nRequired scope: `accounts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["businessName","contactName","contactEmail","onboardingPhoneNumber","handoverPhoneNumber","instruction","acceptFee","acceptedFee"],"properties":{"businessName":{"minLength":2,"maxLength":200,"type":"string"},"contactName":{"minLength":2,"maxLength":200,"type":"string"},"contactEmail":{"minLength":3,"maxLength":320,"type":"string"},"onboardingPhoneNumber":{"pattern":"^\\+[1-9][0-9]{6,14}$","type":"string"},"handoverPhoneNumber":{"pattern":"^\\+[1-9][0-9]{6,14}$","type":"string"},"instruction":{"minLength":20,"maxLength":2000,"type":"string"},"acceptFee":{"type":"boolean"},"acceptedFee":{"additionalProperties":false,"type":"object","required":["currency","amountMinor","scale"],"properties":{"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"amountMinor":{"pattern":"^[0-9]+$","type":"string"},"scale":{"minimum":0,"maximum":9,"type":"integer"}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"]},"get":{"summary":"Your onboarding cases, with each step's owner and standing","tags":["onboarding-cases"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."}},"/v1/accounts/{AC}/onboarding-cases/{OC}":{"patch":{"summary":"Confirm or correct the business and handover numbers on an open assisted case","tags":["onboarding-cases"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["onboardingPhoneNumber","handoverPhoneNumber"],"properties":{"onboardingPhoneNumber":{"pattern":"^\\+[1-9][0-9]{6,14}$","type":"string"},"handoverPhoneNumber":{"pattern":"^\\+[1-9][0-9]{6,14}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."},"get":{"summary":"Read an assisted case and its retained fee, steps and handover evidence","tags":["onboarding-cases"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","state","stateNote","supportCaseSid","wabaSid","handoverMessageSid","businessName","contactName","contactEmail","onboardingPhoneNumber","handoverPhoneNumber","fee","steps","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["onboarding_case"]},"sid":{"type":"string"},"state":{"type":"string"},"stateNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"supportCaseSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"wabaSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"handoverMessageSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"businessName":{"type":"string"},"contactName":{"type":"string"},"contactEmail":{"type":"string"},"onboardingPhoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handoverPhoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"fee":{"anyOf":[{"type":"null"},{"type":"object","required":["currency","amountMinor","scale","chargedAt"],"properties":{"currency":{"type":"string"},"amountMinor":{"pattern":"^-?[0-9]+$","type":"string"},"scale":{"type":"integer"},"chargedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}]},"steps":{"type":"array","items":{"type":"object","required":["key","title","owner","state","blocker","dueAt","note","updatedAt"],"properties":{"key":{"type":"string"},"title":{"type":"string"},"owner":{"type":"string"},"state":{"type":"string"},"blocker":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"updatedAt":{"format":"date-time","type":"string"}}}},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."}},"/v1/accounts/{AC}/opt-in-links":{"post":{"summary":"Create a hosted opt-in form link","tags":["opt-in-links"],"description":"Mints a link to a form ShipMsg hosts. A person who submits it becomes a contact with an OPTED_IN consent for the purpose, citing this link and its exact wording as evidence. The token is returned once and stored hashed.\n\nRequired scope: `contacts:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["label","consentText"],"properties":{"purpose":{"anyOf":[{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["TRANSACTIONAL"]},{"type":"string","enum":["SUPPORT"]}]},"label":{"minLength":1,"maxLength":120,"type":"string"},"consentText":{"minLength":10,"maxLength":1000,"type":"string"},"expiresInDays":{"minimum":1,"maximum":3650,"type":"integer"},"defaultCountry":{"pattern":"^[A-Za-z]{2}$","description":"Two-letter country a number typed without + is read against. Defaults to the organization's country.","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]},"get":{"summary":"List hosted opt-in form links","tags":["opt-in-links"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/opt-in-links/{OL}/revoke":{"post":{"summary":"Revoke a hosted opt-in form link","tags":["opt-in-links"],"description":"The form stops accepting submissions. The row stays, because the consents it collected cite it.\n\nRequired scope: `contacts:write`.","parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OL","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"]}},"/v1/opt-in/{token}":{"get":{"summary":"Read a hosted opt-in form (public)","tags":["opt-in-links"],"parameters":[{"schema":{"minLength":32,"maxLength":256,"type":"string"},"in":"path","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}},"post":{"summary":"Submit a hosted opt-in form (public)","tags":["opt-in-links"],"description":"Creates or finds the contact by phone and records an OPTED_IN consent with source FORM, citing the link and the exact wording that was on the page.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["phone","agreed"],"properties":{"phone":{"minLength":5,"maxLength":32,"type":"string"},"name":{"maxLength":200,"type":"string"},"agreed":{"type":"boolean"}}}}}},"parameters":[{"schema":{"minLength":32,"maxLength":256,"type":"string"},"in":"path","name":"token","required":true}],"security":[],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/notification-unsubscribe/{token}":{"get":{"summary":"Describe a notification e-mail unsubscribe link (public)","tags":["notifications"],"parameters":[{"schema":{"pattern":"^[A-Za-z0-9_-]{32,64}$","type":"string"},"in":"path","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}},"post":{"summary":"Turn off one category of notification e-mail (public, RFC 8058 one-click)","tags":["notifications"],"parameters":[{"schema":{"pattern":"^[A-Za-z0-9_-]{32,64}$","type":"string"},"in":"path","name":"token","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/accounts/{AC}/security/customer-kms":{"get":{"summary":"Read customer key custody configuration and verification state","tags":["accounts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"post":{"summary":"Configure approved customer OpenBao Transit custody","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["provider","address","mount","tokenSecretRef","stepUpToken","approvalSid"],"properties":{"provider":{"type":"string","enum":["CUSTOMER_OPENBAO_TRANSIT"]},"address":{"maxLength":500,"type":"string"},"mount":{"minLength":1,"maxLength":128,"type":"string"},"namespace":{"minLength":1,"maxLength":128,"type":"string"},"tokenSecretRef":{"minLength":1,"maxLength":500,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/security/customer-kms/start":{"post":{"summary":"Start approved customer key custody rotation","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","approvalSid"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/security/customer-kms/activate":{"post":{"summary":"Activate approved customer key custody after verification","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","approvalSid"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/assistant/conversations/{CO}":{"put":{"summary":"Pause or explicitly resume automatic AI replies for one conversation","tags":["assistant"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["paused","conversationVersion"],"properties":{"paused":{"type":"boolean"},"conversationVersion":{"minimum":1,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/assistant":{"get":{"summary":"The AI assistant's settings","tags":["assistant"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"put":{"summary":"Set the AI assistant: on or off, what the business is, tone, hand-off","tags":["assistant"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","businessSummary","tone","language","handoffInboxSid","handoffMessage","neverAnswer"],"properties":{"enabled":{"type":"boolean"},"businessSummary":{"maxLength":2000,"type":"string"},"tone":{"anyOf":[{"type":"string","enum":["FRIENDLY"]},{"type":"string","enum":["FORMAL"]},{"type":"string","enum":["BRIEF"]}]},"language":{"minLength":2,"maxLength":16,"type":"string"},"handoffInboxSid":{"anyOf":[{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"handoffMessage":{"minLength":1,"maxLength":1000,"type":"string"},"neverAnswer":{"maxItems":20,"type":"array","items":{"minLength":1,"maxLength":120,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/assistant/articles":{"get":{"summary":"The knowledge base the assistant answers from","tags":["assistant"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"post":{"summary":"Add a knowledge article","tags":["assistant"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["title","body"],"properties":{"title":{"minLength":1,"maxLength":200,"type":"string"},"body":{"minLength":1,"maxLength":8000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/assistant/articles/{KA}":{"delete":{"summary":"Remove a knowledge article","tags":["assistant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^KA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"KA","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/assistant/draft":{"post":{"summary":"Draft a reply to a conversation from the knowledge base (does not send)","tags":["assistant"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationSid"],"properties":{"conversationSid":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"description":"Required scope: `conversations:write`."}},"/v1/accounts/{AC}/push/vapid":{"get":{"summary":"The public key a browser subscribes with","tags":["push"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:read"],"description":"Required scope: `notifications:read`."}},"/v1/accounts/{AC}/push/subscriptions":{"post":{"summary":"Register this browser for push notifications","tags":["push"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["endpoint","keys"],"properties":{"endpoint":{"minLength":16,"maxLength":2048,"type":"string"},"keys":{"additionalProperties":false,"type":"object","required":["p256dh","auth"],"properties":{"p256dh":{"minLength":60,"maxLength":200,"type":"string"},"auth":{"minLength":16,"maxLength":64,"type":"string"}}},"userAgent":{"maxLength":512,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:read"],"description":"Required scope: `notifications:read`."},"delete":{"summary":"Withdraw this browser's push subscription","tags":["push"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["endpoint"],"properties":{"endpoint":{"minLength":16,"maxLength":2048,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:read"],"description":"Required scope: `notifications:read`."}},"/v1/accounts/{AC}/segments":{"get":{"summary":"List audience segments","tags":["contacts","campaigns"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."},"post":{"summary":"Create and materialize an audience segment","tags":["contacts","campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"additionalProperties":false,"type":"object","required":["name","kind","contactSids"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"kind":{"type":"string","enum":["STATIC"]},"contactSids":{"minItems":1,"maxItems":1000000,"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}},{"additionalProperties":false,"type":"object","required":["name","kind","filters"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"kind":{"type":"string","enum":["DYNAMIC"]},"filters":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"displayNameContains":{"minLength":1,"maxLength":128,"type":"string"},"localeIn":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":2,"maxLength":35,"type":"string"}},"timezoneIn":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}},"createdAfter":{"format":"date-time","type":"string"},"attributes":{"type":"object","additionalProperties":{}},"consent":{"additionalProperties":false,"type":"object","required":["purpose","status"],"properties":{"purpose":{"anyOf":[{"type":"string","enum":["TRANSACTIONAL"]},{"type":"string","enum":["AUTHENTICATION"]},{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["SUPPORT"]}]},"status":{"anyOf":[{"type":"string","enum":["OPTED_IN"]},{"type":"string","enum":["OPTED_OUT"]},{"type":"string","enum":["UNKNOWN"]},{"type":"string","enum":["REVOKED"]},{"type":"string","enum":["EXPIRED"]}]}}},"suppressed":{"type":"boolean"}}}}}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/segments/preview":{"post":{"summary":"Preview typed segment membership without mutation","tags":["contacts","campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"additionalProperties":false,"type":"object","required":["kind","contactSids"],"properties":{"kind":{"type":"string","enum":["STATIC"]},"contactSids":{"minItems":1,"maxItems":1000000,"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}},{"additionalProperties":false,"type":"object","required":["kind","filters"],"properties":{"kind":{"type":"string","enum":["DYNAMIC"]},"filters":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"displayNameContains":{"minLength":1,"maxLength":128,"type":"string"},"localeIn":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":2,"maxLength":35,"type":"string"}},"timezoneIn":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}},"createdAfter":{"format":"date-time","type":"string"},"attributes":{"type":"object","additionalProperties":{}},"consent":{"additionalProperties":false,"type":"object","required":["purpose","status"],"properties":{"purpose":{"anyOf":[{"type":"string","enum":["TRANSACTIONAL"]},{"type":"string","enum":["AUTHENTICATION"]},{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["SUPPORT"]}]},"status":{"anyOf":[{"type":"string","enum":["OPTED_IN"]},{"type":"string","enum":["OPTED_OUT"]},{"type":"string","enum":["UNKNOWN"]},{"type":"string","enum":["REVOKED"]},{"type":"string","enum":["EXPIRED"]}]}}},"suppressed":{"type":"boolean"}}}}}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/segments/{SG}":{"get":{"summary":"Get a contact segment","tags":["contacts","campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SG[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SG","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."},"patch":{"summary":"Update and rematerialize a segment","tags":["contacts","campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"additionalProperties":false,"type":"object","required":["kind","contactSids"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"kind":{"type":"string","enum":["STATIC"]},"contactSids":{"minItems":1,"maxItems":1000000,"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}},{"additionalProperties":false,"type":"object","required":["kind","filters"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"kind":{"type":"string","enum":["DYNAMIC"]},"filters":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"displayNameContains":{"minLength":1,"maxLength":128,"type":"string"},"localeIn":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":2,"maxLength":35,"type":"string"}},"timezoneIn":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}},"createdAfter":{"format":"date-time","type":"string"},"attributes":{"type":"object","additionalProperties":{}},"consent":{"additionalProperties":false,"type":"object","required":["purpose","status"],"properties":{"purpose":{"anyOf":[{"type":"string","enum":["TRANSACTIONAL"]},{"type":"string","enum":["AUTHENTICATION"]},{"type":"string","enum":["MARKETING"]},{"type":"string","enum":["SUPPORT"]}]},"status":{"anyOf":[{"type":"string","enum":["OPTED_IN"]},{"type":"string","enum":["OPTED_OUT"]},{"type":"string","enum":["UNKNOWN"]},{"type":"string","enum":["REVOKED"]},{"type":"string","enum":["EXPIRED"]}]}}},"suppressed":{"type":"boolean"}}}}}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SG[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SG","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."},"delete":{"summary":"Delete an unused segment","tags":["contacts","campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SG[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SG","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/segments/{SG}/refresh":{"post":{"summary":"Refresh dynamic segment membership","tags":["contacts","campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SG[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SG","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/segments/{SG}/members":{"get":{"summary":"List materialized segment members and provenance","tags":["contacts","campaigns"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SG[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SG","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/webhooks":{"post":{"summary":"Create a customer webhook endpoint","tags":["webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"format":"uri","maxLength":2048,"type":"string"},"apiVersion":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"eventFilters":{"maxItems":128,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}},"timeoutMs":{"minimum":1000,"maximum":30000,"type":"integer"},"concurrencyCap":{"minimum":1,"maximum":256,"type":"integer"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}},"example":{"url":"https://example.com/webhooks/shipmsg","eventFilters":["message.delivered","message.failed"],"stepUpToken":"stp_3b1f0c5e9a7d4e2f8c6b0a9d1e3f5a7c"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"webhook_endpoint","sid":"sid","url":"url","state":"state","apiVersion":"apiVersion","eventFilters":["eventFilters"],"timeoutMs":1,"concurrencyCap":1,"breakerState":"breakerState","verifiedAt":"verifiedAt","lastSuccessAt":"lastSuccessAt","lastFailureAt":"lastFailureAt","verification":{"checkedAt":"checkedAt","passed":false,"checks":[{"key":"key","status":"status","detail":"detail"}]},"previousSecretExpiresAt":"previousSecretExpiresAt","livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Register an HTTPS endpoint for events. It receives nothing until verified. Needs a recent step-up (`stepUpToken`).\n\nRequired scope: `webhooks:write`."},"get":{"summary":"List customer webhook endpoints","tags":["webhooks"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","data","hasMore","nextCursor","dataAsOf"],"properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}},"example":{"object":"list","data":[{"object":"webhook_endpoint","sid":"sid","url":"url","state":"state","apiVersion":"apiVersion","eventFilters":["eventFilters"],"timeoutMs":1,"concurrencyCap":1,"breakerState":"breakerState","verifiedAt":"verifiedAt","lastSuccessAt":"lastSuccessAt","lastFailureAt":"lastFailureAt","verification":{"checkedAt":"checkedAt","passed":false,"checks":[{"key":"key","status":"status","detail":"detail"}]},"previousSecretExpiresAt":"previousSecretExpiresAt","livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}],"hasMore":false,"nextCursor":"nextCursor","dataAsOf":"dataAsOf"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:read"],"description":"List your webhook endpoints with their verification and delivery state.\n\nRequired scope: `webhooks:read`."}},"/v1/accounts/{AC}/webhooks/{WH}":{"get":{"summary":"Fetch a customer webhook endpoint","tags":["webhooks"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:read"],"description":"Required scope: `webhooks:read`."},"patch":{"summary":"Update a customer webhook endpoint","tags":["webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"url":{"format":"uri","maxLength":2048,"type":"string"},"apiVersion":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"eventFilters":{"maxItems":128,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}},"timeoutMs":{"minimum":1000,"maximum":30000,"type":"integer"},"concurrencyCap":{"minimum":1,"maximum":256,"type":"integer"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}},"example":{"eventFilters":["message.*"],"timeoutMs":10000}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"webhook_endpoint","sid":"sid","url":"url","state":"state","apiVersion":"apiVersion","eventFilters":["eventFilters"],"timeoutMs":1,"concurrencyCap":1,"breakerState":"breakerState","verifiedAt":"verifiedAt","lastSuccessAt":"lastSuccessAt","lastFailureAt":"lastFailureAt","verification":{"checkedAt":"checkedAt","passed":false,"checks":[{"key":"key","status":"status","detail":"detail"}]},"previousSecretExpiresAt":"previousSecretExpiresAt","livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Change an endpoint's URL, event filters, timeout or concurrency.\n\nRequired scope: `webhooks:write`."},"delete":{"summary":"Disable a customer webhook endpoint","tags":["webhooks"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhook-event-types":{"get":{"summary":"List the event types a webhook endpoint can subscribe to","tags":["webhooks","events"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"type":"object","required":["type","family","deprecated","replacedBy"],"properties":{"type":{"type":"string"},"family":{"type":"string"},"deprecated":{"type":"boolean"},"replacedBy":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:read"],"description":"Required scope: `webhooks:read`."}},"/v1/accounts/{AC}/webhooks/{WH}/verify":{"post":{"summary":"Verify endpoint ownership and activate delivery","tags":["webhooks"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/test":{"post":{"summary":"Send a signed test.ping event","tags":["webhooks"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","action","succeeded"],"properties":{"object":{"type":"string","enum":["webhook_endpoint_action"]},"sid":{"type":"string"},"action":{"type":"string"},"succeeded":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},"example":{"object":"webhook_endpoint_action","sid":"sid","action":"action","succeeded":false}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Send a signed `test.ping` event to the endpoint and report how it answered.\n\nRequired scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/pause":{"post":{"summary":"Pause endpoint delivery","tags":["webhooks"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/resume":{"post":{"summary":"Resume endpoint delivery","tags":["webhooks"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/secret/rotate":{"post":{"summary":"Rotate the endpoint signing secret with overlap","tags":["webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"expiresAt":{"format":"date-time","type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}},"example":{"stepUpToken":"stp_3b1f0c5e9a7d4e2f8c6b0a9d1e3f5a7c","expiresAt":"2026-09-27T09:30:00.000Z"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"example":{"object":"webhook_endpoint","sid":"sid","url":"url","state":"state","apiVersion":"apiVersion","eventFilters":["eventFilters"],"timeoutMs":1,"concurrencyCap":1,"breakerState":"breakerState","verifiedAt":"verifiedAt","lastSuccessAt":"lastSuccessAt","lastFailureAt":"lastFailureAt","verification":{"checkedAt":"checkedAt","passed":false,"checks":[{"key":"key","status":"status","detail":"detail"}]},"previousSecretExpiresAt":"previousSecretExpiresAt","livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Issue a new signing secret. The old one keeps signing alongside it until `expiresAt`, so you can deploy the new one without dropping events.\n\nRequired scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/secret/end-overlap":{"post":{"summary":"End the signing-secret rotation overlap immediately","tags":["webhooks"],"description":"Expires the previous signing secret now. Deliveries stop carrying its `v1=` signature, so any integration still verifying with the old secret fails from this moment.\n\nRequired scope: `webhooks:write`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","url","state","apiVersion","eventFilters","timeoutMs","concurrencyCap","breakerState","verifiedAt","lastSuccessAt","lastFailureAt","verification","previousSecretExpiresAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["webhook_endpoint"]},"sid":{"type":"string"},"url":{"type":"string"},"state":{"type":"string"},"apiVersion":{"type":"string"},"eventFilters":{"type":"array","items":{"type":"string"}},"timeoutMs":{"type":"integer"},"concurrencyCap":{"type":"integer"},"breakerState":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verification":{"anyOf":[{"type":"object","required":["checkedAt","passed","checks"],"properties":{"checkedAt":{"type":"string"},"passed":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","required":["key","status","detail"],"properties":{"key":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},{"type":"null"}]},"secret":{"description":"Returned once on create or rotation.","type":"string"},"standardWebhooksSecret":{"description":"The same signing key encoded for Standard Webhooks verifier libraries (webhook-signature header). Returned once on create or rotation.","type":"string"},"previousSecretExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"]}},"/v1/accounts/{AC}/events":{"get":{"summary":"List retained customer events","tags":["events"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"anyOf":[{"type":"string","enum":["createdAt"]},{"type":"string","enum":["-createdAt"]}]},"in":"query","name":"sort","required":false},{"schema":{"minLength":1,"maxLength":128,"type":"string"},"in":"query","name":"type","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"createdAfter","required":false},{"schema":{"minLength":3,"maxLength":128,"type":"string"},"in":"query","name":"resource","required":false},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"endpointSid","required":false},{"schema":{"anyOf":[{"type":"string","enum":["PENDING"]},{"type":"string","enum":["IN_FLIGHT"]},{"type":"string","enum":["SUCCEEDED"]},{"type":"string","enum":["FAILED"]},{"type":"string","enum":["DROPPED"]}]},"in":"query","name":"deliveryState","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["object","sid","id","type","apiVersion","occurredAt","createdAt","sequence","livemode","accountSid","subaccountSid","data"],"properties":{"object":{"type":"string","enum":["event"]},"sid":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"id":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","description":"Deprecated alias of `sid`, kept for existing integrations.","type":"string"},"type":{"type":"string"},"apiVersion":{"type":"string"},"occurredAt":{"type":"string"},"createdAt":{"type":"string"},"sequence":{"type":"integer"},"livemode":{"type":"boolean"},"accountSid":{"type":"string"},"subaccountSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}},"example":{"data":[{"object":"event","sid":"EV01J8Z3K4M5N6P7Q8R9S0T1V2W3","id":"EV01J8Z3K4M5N6P7Q8R9S0T1V2W3","type":"type","apiVersion":"apiVersion","occurredAt":"occurredAt","createdAt":"createdAt","sequence":1,"livemode":false,"accountSid":"accountSid","subaccountSid":"subaccountSid","data":{}}],"hasMore":false,"nextCursor":"nextCursor","dataAsOf":"dataAsOf"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["events:read"],"description":"List the events retained for your account, newest first, whether or not a webhook received them.\n\nRequired scope: `events:read`."}},"/v1/accounts/{AC}/events/{EV}":{"get":{"summary":"Fetch a retained customer event","tags":["events"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"EV","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","id","type","apiVersion","occurredAt","createdAt","sequence","livemode","accountSid","subaccountSid","data"],"properties":{"object":{"type":"string","enum":["event"]},"sid":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"id":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","description":"Deprecated alias of `sid`, kept for existing integrations.","type":"string"},"type":{"type":"string"},"apiVersion":{"type":"string"},"occurredAt":{"type":"string"},"createdAt":{"type":"string"},"sequence":{"type":"integer"},"livemode":{"type":"boolean"},"accountSid":{"type":"string"},"subaccountSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"example":{"object":"event","sid":"EV01J8Z3K4M5N6P7Q8R9S0T1V2W3","id":"EV01J8Z3K4M5N6P7Q8R9S0T1V2W3","type":"type","apiVersion":"apiVersion","occurredAt":"occurredAt","createdAt":"createdAt","sequence":1,"livemode":false,"accountSid":"accountSid","subaccountSid":"subaccountSid","data":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["events:read"],"description":"Fetch one event exactly as it was delivered to your webhooks.\n\nRequired scope: `events:read`."}},"/v1/accounts/{AC}/webhook-deliveries":{"get":{"summary":"List webhook deliveries for one retained resource","tags":["webhooks","events"],"parameters":[{"schema":{"minLength":3,"maxLength":128,"type":"string"},"in":"query","name":"resourceSid","required":true},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","endpointSid","eventId","eventType","sequence","state","attemptCount","nextAttemptAt","completedAt","lastStatusCode","lastError","replayOfDeliverySid","livemode","createdAt","updatedAt","ageOutAt"],"properties":{"object":{"type":"string","enum":["webhook_delivery"]},"sid":{"type":"string"},"endpointSid":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string"},"sequence":{"type":"integer"},"state":{"type":"string"},"attemptCount":{"type":"integer"},"nextAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"replayOfDeliverySid":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"ageOutAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:read"],"description":"Required scope: `webhooks:read`."}},"/v1/accounts/{AC}/webhooks/{WH}/deliveries":{"get":{"summary":"List webhook delivery history","tags":["webhooks","events"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"anyOf":[{"type":"string","enum":["createdAt"]},{"type":"string","enum":["-createdAt"]}]},"in":"query","name":"sort","required":false},{"schema":{"minLength":3,"maxLength":128,"type":"string"},"in":"query","name":"resourceSid","required":false},{"schema":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"eventId","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","endpointSid","eventId","eventType","sequence","state","attemptCount","nextAttemptAt","completedAt","lastStatusCode","lastError","replayOfDeliverySid","livemode","createdAt","updatedAt","ageOutAt"],"properties":{"object":{"type":"string","enum":["webhook_delivery"]},"sid":{"type":"string"},"endpointSid":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string"},"sequence":{"type":"integer"},"state":{"type":"string"},"attemptCount":{"type":"integer"},"nextAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"replayOfDeliverySid":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"ageOutAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:read"],"description":"Required scope: `webhooks:read`."}},"/v1/accounts/{AC}/webhooks/{WH}/deliveries/{WD}":{"get":{"summary":"Fetch webhook delivery request and attempt history","tags":["webhooks","events"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"pattern":"^WD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WD","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["object","sid","endpointSid","eventId","eventType","sequence","state","attemptCount","nextAttemptAt","completedAt","lastStatusCode","lastError","replayOfDeliverySid","livemode","createdAt","updatedAt","ageOutAt"],"properties":{"object":{"type":"string","enum":["webhook_delivery"]},"sid":{"type":"string"},"endpointSid":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string"},"sequence":{"type":"integer"},"state":{"type":"string"},"attemptCount":{"type":"integer"},"nextAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"replayOfDeliverySid":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"ageOutAt":{"type":"string"}}},{"type":"object","required":["apiVersion","endpointUrl","eventOccurredAt","eventCreatedAt","requestBody","requestHeaders","attempts"],"properties":{"apiVersion":{"type":"string"},"endpointUrl":{"type":"string"},"eventOccurredAt":{"type":"string"},"eventCreatedAt":{"type":"string"},"requestBody":{"additionalProperties":true,"type":"object","properties":{}},"requestHeaders":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"attempts":{"type":"array","items":{"type":"object","required":["attempt","requestId","requestedAt","completedAt","latencyMs","statusCode","succeeded","error","responseBody","retryDecision"],"properties":{"attempt":{"type":"integer"},"requestId":{"type":"string"},"requestedAt":{"type":"string"},"completedAt":{"type":"string"},"latencyMs":{"type":"integer"},"statusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"succeeded":{"type":"boolean"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"responseBody":{"anyOf":[{"type":"string"},{"type":"null"}]},"retryDecision":{"type":"string"}}}}}}]}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:read"],"description":"Required scope: `webhooks:read`."}},"/v1/accounts/{AC}/events/{EV}/redeliver":{"post":{"summary":"Redeliver a retained event to its subscribed endpoints (DEV-017)","tags":["webhooks","events"],"description":"Send a retained event again, to every subscribed endpoint or to one with `endpointSid`.\n\nRequired scope: `webhooks:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"endpointSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"example":{"endpointSid":"WH01J8Z3K4M5N6P7Q8R9S0T1V2W3"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"EV","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","eventId","eventType","deliveries","skipped"],"properties":{"object":{"type":"string","enum":["event_redelivery"]},"eventId":{"type":"string"},"eventType":{"type":"string"},"deliveries":{"type":"array","items":{"type":"object","required":["object","sid","endpointSid","eventId","eventType","sequence","state","attemptCount","nextAttemptAt","completedAt","lastStatusCode","lastError","replayOfDeliverySid","livemode","createdAt","updatedAt","ageOutAt"],"properties":{"object":{"type":"string","enum":["webhook_delivery"]},"sid":{"type":"string"},"endpointSid":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string"},"sequence":{"type":"integer"},"state":{"type":"string"},"attemptCount":{"type":"integer"},"nextAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"replayOfDeliverySid":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"ageOutAt":{"type":"string"}}}},"skipped":{"type":"array","items":{"type":"object","required":["endpointSid","reason"],"properties":{"endpointSid":{"type":"string"},"reason":{"anyOf":[{"type":"string","enum":["not_subscribed"]},{"type":"string","enum":["already_pending"]},{"type":"string","enum":["already_delivered"]}]}}}}}},"example":{"object":"event_redelivery","eventId":"eventId","eventType":"eventType","deliveries":[{"object":"webhook_delivery","sid":"sid","endpointSid":"endpointSid","eventId":"eventId","eventType":"eventType","sequence":1,"state":"state","attemptCount":1,"nextAttemptAt":"nextAttemptAt","completedAt":"completedAt","lastStatusCode":1,"lastError":"lastError","replayOfDeliverySid":"replayOfDeliverySid","livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","ageOutAt":"ageOutAt"}],"skipped":[{"endpointSid":"endpointSid","reason":"not_subscribed"}]}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"]}},"/v1/accounts/{AC}/events/redeliver":{"post":{"summary":"Redeliver a selection of retained events","tags":["webhooks","events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["eventSids"],"properties":{"eventSids":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"endpointSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/deliveries/{WD}/retry":{"post":{"summary":"Redeliver a retained event without reprocessing its resource","tags":["webhooks","events"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"pattern":"^WD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WD","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","endpointSid","eventId","eventType","sequence","state","attemptCount","nextAttemptAt","completedAt","lastStatusCode","lastError","replayOfDeliverySid","livemode","createdAt","updatedAt","ageOutAt"],"properties":{"object":{"type":"string","enum":["webhook_delivery"]},"sid":{"type":"string"},"endpointSid":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string"},"sequence":{"type":"integer"},"state":{"type":"string"},"attemptCount":{"type":"integer"},"nextAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"replayOfDeliverySid":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"ageOutAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/webhooks/{WH}/deliveries/retry":{"post":{"summary":"Retry queued or failed webhook deliveries, oldest first","tags":["webhooks","events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"deliverySids":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"pattern":"^WD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"state":{"anyOf":[{"type":"string","enum":["pending"]},{"type":"string","enum":["failed"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","deliveries","skipped"],"properties":{"object":{"type":"string","enum":["webhook_delivery_retry_batch"]},"deliveries":{"type":"array","items":{"type":"object","required":["object","sid","endpointSid","eventId","eventType","sequence","state","attemptCount","nextAttemptAt","completedAt","lastStatusCode","lastError","replayOfDeliverySid","livemode","createdAt","updatedAt","ageOutAt"],"properties":{"object":{"type":"string","enum":["webhook_delivery"]},"sid":{"type":"string"},"endpointSid":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string"},"sequence":{"type":"integer"},"state":{"type":"string"},"attemptCount":{"type":"integer"},"nextAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"replayOfDeliverySid":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"ageOutAt":{"type":"string"}}}},"skipped":{"type":"array","items":{"type":"object","required":["deliverySid","reason"],"properties":{"deliverySid":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["webhooks:write"],"description":"Required scope: `webhooks:write`."}},"/v1/accounts/{AC}/operations":{"get":{"summary":"List asynchronous operations","tags":["operations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"anyOf":[{"type":"string","enum":["createdAt"]},{"type":"string","enum":["-createdAt"]}]},"in":"query","name":"sort","required":false},{"schema":{"maxLength":64,"type":"string"},"in":"query","name":"type","required":false},{"schema":{"maxLength":64,"type":"string"},"in":"query","name":"state","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["object","sid","type","state","progress","currentStep","steps","resultUrl","error","retryEligible","cancelRequested","blocker","attempt","input","createdBy","livemode","createdAt","updatedAt","startedAt","endedAt","expiresAt"],"properties":{"object":{"type":"string","enum":["operation"]},"sid":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","description":"Operation SID","type":"string"},"type":{"anyOf":[{"type":"string","enum":["ONBOARD_SENDER"]},{"type":"string","enum":["REGISTER"]},{"type":"string","enum":["DEREGISTER"]},{"type":"string","enum":["DISPLAY_NAME"]},{"type":"string","enum":["NUMBER_MIGRATION"]},{"type":"string","enum":["TEMPLATE_SUBMIT"]},{"type":"string","enum":["TEMPLATE_EDIT"]},{"type":"string","enum":["TEMPLATE_DELETE"]},{"type":"string","enum":["TEMPLATE_MIGRATION"]},{"type":"string","enum":["IMPORT"]},{"type":"string","enum":["EXPORT"]},{"type":"string","enum":["CAMPAIGN_DRY_RUN"]},{"type":"string","enum":["CAMPAIGN_TEST_SEND"]},{"type":"string","enum":["BILLING_MODE_SWITCH"]},{"type":"string","enum":["SANDBOX_RESET"]},{"type":"string","enum":["DELETION"]},{"type":"string","enum":["WABA_DISCONNECT"]},{"type":"string","enum":["FLOWS_KEY_UPLOAD"]},{"type":"string","enum":["FLOW_PUBLISH"]},{"type":"string","enum":["FLOW_DEPRECATE"]},{"type":"string","enum":["PRIVACY_REQUEST"]},{"type":"string","enum":["ACCOUNT_SUSPENSION"]},{"type":"string","enum":["ACCOUNT_REINSTATEMENT"]},{"type":"string","enum":["ACCOUNT_CLOSURE"]},{"type":"string","enum":["ORGANIZATION_CLOSURE"]},{"type":"string","enum":["BUSINESS_PROFILE_UPDATE"]},{"type":"string","enum":["WABA_RECONNECT"]},{"type":"string","enum":["APP_CREDENTIAL_ROTATION"]},{"type":"string","enum":["PROVIDER_VERSION_ROLLOUT"]},{"type":"string","enum":["SUBSCRIPTION_RECONCILE"]},{"type":"string","enum":["COEXISTENCE_HISTORY_SYNC"]}]},"state":{"anyOf":[{"type":"string","enum":["PENDING"]},{"type":"string","enum":["QUEUED"]},{"type":"string","enum":["VALIDATING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["WAITING_FOR_APPROVAL"]},{"type":"string","enum":["WAITING_FOR_CUSTOMER"]},{"type":"string","enum":["WAITING_FOR_PROVIDER"]},{"type":"string","enum":["RETRYING"]},{"type":"string","enum":["BLOCKED_DISCONNECTED"]},{"type":"string","enum":["SUCCEEDED"]},{"type":"string","enum":["PARTIALLY_SUCCEEDED"]},{"type":"string","enum":["FAILED"]},{"type":"string","enum":["CANCELED"]}]},"progress":{"additionalProperties":{"type":"number"},"type":"object","properties":{}},"currentStep":{"anyOf":[{"type":"string"},{"type":"null"}]},"steps":{"type":"array","items":{}},"resultUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"retryEligible":{"type":"boolean"},"cancelRequested":{"type":"boolean"},"blocker":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"attempt":{"type":"integer"},"input":{"additionalProperties":true,"type":"object","properties":{}},"createdBy":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"endedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiresAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."}},"/v1/accounts/{AC}/operations/{OP}":{"get":{"summary":"Fetch an asynchronous operation","tags":["operations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","type","state","progress","currentStep","steps","resultUrl","error","retryEligible","cancelRequested","blocker","attempt","input","createdBy","livemode","createdAt","updatedAt","startedAt","endedAt","expiresAt"],"properties":{"object":{"type":"string","enum":["operation"]},"sid":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","description":"Operation SID","type":"string"},"type":{"anyOf":[{"type":"string","enum":["ONBOARD_SENDER"]},{"type":"string","enum":["REGISTER"]},{"type":"string","enum":["DEREGISTER"]},{"type":"string","enum":["DISPLAY_NAME"]},{"type":"string","enum":["NUMBER_MIGRATION"]},{"type":"string","enum":["TEMPLATE_SUBMIT"]},{"type":"string","enum":["TEMPLATE_EDIT"]},{"type":"string","enum":["TEMPLATE_DELETE"]},{"type":"string","enum":["TEMPLATE_MIGRATION"]},{"type":"string","enum":["IMPORT"]},{"type":"string","enum":["EXPORT"]},{"type":"string","enum":["CAMPAIGN_DRY_RUN"]},{"type":"string","enum":["CAMPAIGN_TEST_SEND"]},{"type":"string","enum":["BILLING_MODE_SWITCH"]},{"type":"string","enum":["SANDBOX_RESET"]},{"type":"string","enum":["DELETION"]},{"type":"string","enum":["WABA_DISCONNECT"]},{"type":"string","enum":["FLOWS_KEY_UPLOAD"]},{"type":"string","enum":["FLOW_PUBLISH"]},{"type":"string","enum":["FLOW_DEPRECATE"]},{"type":"string","enum":["PRIVACY_REQUEST"]},{"type":"string","enum":["ACCOUNT_SUSPENSION"]},{"type":"string","enum":["ACCOUNT_REINSTATEMENT"]},{"type":"string","enum":["ACCOUNT_CLOSURE"]},{"type":"string","enum":["ORGANIZATION_CLOSURE"]},{"type":"string","enum":["BUSINESS_PROFILE_UPDATE"]},{"type":"string","enum":["WABA_RECONNECT"]},{"type":"string","enum":["APP_CREDENTIAL_ROTATION"]},{"type":"string","enum":["PROVIDER_VERSION_ROLLOUT"]},{"type":"string","enum":["SUBSCRIPTION_RECONCILE"]},{"type":"string","enum":["COEXISTENCE_HISTORY_SYNC"]}]},"state":{"anyOf":[{"type":"string","enum":["PENDING"]},{"type":"string","enum":["QUEUED"]},{"type":"string","enum":["VALIDATING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["WAITING_FOR_APPROVAL"]},{"type":"string","enum":["WAITING_FOR_CUSTOMER"]},{"type":"string","enum":["WAITING_FOR_PROVIDER"]},{"type":"string","enum":["RETRYING"]},{"type":"string","enum":["BLOCKED_DISCONNECTED"]},{"type":"string","enum":["SUCCEEDED"]},{"type":"string","enum":["PARTIALLY_SUCCEEDED"]},{"type":"string","enum":["FAILED"]},{"type":"string","enum":["CANCELED"]}]},"progress":{"additionalProperties":{"type":"number"},"type":"object","properties":{}},"currentStep":{"anyOf":[{"type":"string"},{"type":"null"}]},"steps":{"type":"array","items":{}},"resultUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"retryEligible":{"type":"boolean"},"cancelRequested":{"type":"boolean"},"blocker":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"attempt":{"type":"integer"},"input":{"additionalProperties":true,"type":"object","properties":{}},"createdBy":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"endedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiresAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."}},"/v1/accounts/{AC}/operations/{OP}/result":{"get":{"summary":"Fetch a completed operation result","tags":["operations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."}},"/v1/accounts/{AC}/operations/{OP}/children":{"get":{"summary":"List per-item operation results","tags":["operations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["itemRef","state","result","error","createdAt","updatedAt"],"properties":{"itemRef":{"type":"string"},"state":{"type":"string"},"result":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."}},"/v1/accounts/{AC}/operations/{OP}/cancel":{"post":{"summary":"Cancel an asynchronous operation","tags":["operations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:write"],"description":"Required scope: `operations:write`."}},"/v1/accounts/{AC}/operations/{OP}/retry":{"post":{"summary":"Retry an asynchronous operation","tags":["operations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:write"],"description":"Required scope: `operations:write`."}},"/v1/accounts/{AC}/onboarding/sessions":{"get":{"summary":"List resumable and recent Embedded Signup sessions","tags":["onboarding"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."},"post":{"summary":"Create an Embedded Signup v4 session","tags":["onboarding"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["dashboardSessionId"],"properties":{"dashboardSessionId":{"minLength":16,"maxLength":512,"type":"string"},"hosted":{"type":"boolean"},"reconnectOperationSid":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/onboarding/sessions/{id}":{"get":{"summary":"Fetch an Embedded Signup session","tags":["onboarding"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."}},"/v1/accounts/{AC}/onboarding/sessions/{id}/readiness":{"get":{"summary":"Explain the exact onboarding readiness decision and next action","tags":["onboarding"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."}},"/v1/accounts/{AC}/onboarding/sessions/{id}/cancel":{"post":{"summary":"Cancel an unfinished Embedded Signup session","tags":["onboarding"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/onboarding/sessions/{id}/complete":{"post":{"summary":"Consume an Embedded Signup event and exchange its code","tags":["onboarding"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["dashboardSessionId","state","event"],"properties":{"dashboardSessionId":{"minLength":16,"maxLength":512,"type":"string"},"state":{"minLength":32,"maxLength":256,"type":"string"},"sessionId":{"minLength":1,"maxLength":512,"type":"string"},"event":{"anyOf":[{"type":"string","enum":["FINISH"]},{"type":"string","enum":["FINISH_ONLY_WABA"]},{"type":"string","enum":["FINISH_WHATSAPP_BUSINESS_APP_ONBOARDING"]},{"type":"string","enum":["FINISH_OBO_MIGRATION"]},{"type":"string","enum":["FINISH_GRANT_ONLY_API_ACCESS"]},{"type":"string","enum":["CANCEL"]},{"type":"string","enum":["ERROR"]}]},"code":{"minLength":8,"maxLength":4096,"type":"string"},"wabaId":{"minLength":1,"maxLength":128,"type":"string"},"phoneNumberId":{"minLength":1,"maxLength":128,"type":"string"},"businessId":{"minLength":1,"maxLength":128,"type":"string"},"portfolioId":{"minLength":1,"maxLength":128,"type":"string"},"currentStep":{"minLength":1,"maxLength":128,"type":"string"},"errorMessage":{"minLength":1,"maxLength":1024,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/wabas":{"get":{"summary":"List authorized WhatsApp Business Accounts","tags":["onboarding"],"parameters":[{"schema":{"minLength":1,"maxLength":128,"type":"string"},"in":"query","name":"businessId","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["object","sid","providerWabaId","providerPortfolioId","displayName","status","billingMode","connectionState","subscribedAppState","lastAuthorizationVerifiedAt","reviewStatus","banState","enforcement","portfolioOwnership","createdAt"],"properties":{"object":{"type":"string","enum":["waba"]},"sid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"providerWabaId":{"type":"string"},"providerPortfolioId":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayName":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["pending"]},{"type":"string","enum":["connected"]},{"type":"string","enum":["restricted"]},{"type":"string","enum":["disconnected"]}]},"billingMode":{"anyOf":[{"type":"string","enum":["billed_by_meta"]},{"type":"string","enum":["billed_by_ship_messages"]}]},"connectionState":{"type":"string"},"subscribedAppState":{"type":"string"},"lastAuthorizationVerifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"reviewStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"banState":{"anyOf":[{"type":"string"},{"type":"null"}]},"enforcement":{"anyOf":[{"type":"object","required":["kind","reason","at"],"properties":{"kind":{"anyOf":[{"type":"string","enum":["banned"]},{"type":"string","enum":["ban_scheduled"]},{"type":"string","enum":["violation"]},{"type":"string","enum":["restricted"]}]},"reason":{"type":"string"},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"portfolioOwnership":{"anyOf":[{"type":"string","enum":["customer_portfolio"]},{"type":"string","enum":["shipmsg_portfolio"]}]},"createdAt":{"format":"date-time","type":"string"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["wabas:read"],"description":"Required scope: `wabas:read`."}},"/v1/accounts/{AC}/senders/storage-regions":{"get":{"summary":"List provider storage regions permitted by this account's residency policy","tags":["senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","homeRegion","dataResidencyPolicy","data"],"properties":{"object":{"type":"string","enum":["provider_storage_regions"]},"homeRegion":{"type":"string"},"dataResidencyPolicy":{"type":"string"},"data":{"type":"array","items":{"type":"object","required":["code","placementRegion","allowed","reason"],"properties":{"code":{"type":"string"},"placementRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"allowed":{"type":"boolean"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."}},"/v1/accounts/{AC}/senders":{"post":{"summary":"Subscribe a WABA and register a Cloud API sender","tags":["senders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["wabaSid","displayName","registration"],"properties":{"wabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"providerPhoneNumberId":{"minLength":1,"maxLength":128,"type":"string"},"phoneNumber":{"minLength":7,"maxLength":32,"type":"string"},"displayName":{"minLength":1,"maxLength":256,"type":"string"},"registration":{"anyOf":[{"additionalProperties":false,"type":"object","required":["method","onboardingSessionId"],"properties":{"method":{"type":"string","enum":["embedded_signup_session"]},"onboardingSessionId":{"format":"uuid","type":"string"},"dataLocalizationRegion":{"minLength":2,"maxLength":32,"type":"string"},"migrationPin":{"pattern":"^[0-9]{6}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["existing_number"]},"registrationPin":{"pattern":"^[0-9]{6}$","type":"string"},"dataLocalizationRegion":{"minLength":2,"maxLength":32,"type":"string"}}}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."},"get":{"summary":"List WhatsApp senders and current provider readiness","tags":["senders"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["object","sid","wabaSid","status","health","readiness","registrationState","twoFactor","restriction","disconnect","billingMode","pairRate","providerFactsVerifiedAt","lastSyncedAt","lastEvent","providerNumberStatus","providerStorageRegion","displayPhoneNumber","displayName","qualityRating","throughputMps","throughputUpgradeState","throughputUpgradeStartedAt","nameStatus","officialBusinessAccount","coexistence","coexistenceSync","capabilities","provider","portfolioOwnership","providerEstate","refreshedAt","callingSettings","flowsPublicKeyState","webhookOverride","limits","statusCallbackUrl","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender"]},"sid":{"type":"string"},"wabaSid":{"type":"string"},"status":{"type":"string"},"health":{"type":"string"},"readiness":{"type":"object","required":["state","blockers","attention"],"properties":{"state":{"anyOf":[{"type":"string","enum":["ready"]},{"type":"string","enum":["attention"]},{"type":"string","enum":["blocked"]}]},"blockers":{"type":"array","items":{"type":"string"}},"attention":{"type":"array","items":{"type":"string"}}}},"registrationState":{"type":"string"},"twoFactor":{"type":"object","required":["state","updatedAt"],"properties":{"state":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"restriction":{"anyOf":[{"type":"object","required":["class","endsAt"],"properties":{"class":{"type":"string"},"endsAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"disconnect":{"anyOf":[{"type":"object","required":["reason","initiator","at"],"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"initiator":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"billingMode":{"type":"string"},"pairRate":{"type":"object","required":["deferredMessages"],"properties":{"deferredMessages":{"type":"integer"}}},"providerFactsVerifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSyncedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastEvent":{"anyOf":[{"type":"object","required":["field","receivedAt"],"properties":{"field":{"type":"string"},"receivedAt":{"type":"string"}}},{"type":"null"}]},"providerNumberStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerStorageRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayPhoneNumber":{"type":"string"},"displayName":{"type":"string"},"qualityRating":{"type":"string"},"throughputMps":{"type":"integer"},"throughputUpgradeState":{"type":"string"},"throughputUpgradeStartedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"nameStatus":{"type":"string"},"officialBusinessAccount":{"type":"boolean"},"coexistence":{"type":"boolean"},"coexistenceSync":{"anyOf":[{"type":"object","required":["state","requestedAt","deadlineAt","completedAt","progressPercent","phase","messagesImported","messagesSkipped","contactsImported","historySharingDeclined","lastChunkAt"],"properties":{"state":{"type":"string"},"requestedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deadlineAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"progressPercent":{"anyOf":[{"type":"integer"},{"type":"null"}]},"phase":{"anyOf":[{"type":"integer"},{"type":"null"}]},"messagesImported":{"type":"integer"},"messagesSkipped":{"type":"integer"},"contactsImported":{"type":"integer"},"historySharingDeclined":{"type":"boolean"},"lastChunkAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"capabilities":{"additionalProperties":true,"type":"object","properties":{}},"provider":{"type":"string","enum":["META_WHATSAPP"]},"portfolioOwnership":{"type":"string"},"providerEstate":{"type":"object","required":["managedBy","canManage","canRegister"],"properties":{"managedBy":{"anyOf":[{"type":"string","enum":["customer"]},{"type":"string","enum":["shipmsg"]}]},"canManage":{"type":"boolean"},"canRegister":{"type":"boolean"}}},"refreshedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"callingSettings":{"additionalProperties":true,"type":"object","properties":{}},"flowsPublicKeyState":{"type":"string"},"webhookOverride":{"type":"object","required":["callbackUri","state","verifiedAt"],"properties":{"callbackUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"limits":{"type":"object","required":["uniqueUsers24h","uniqueUsers24hUsed"],"properties":{"uniqueUsers24h":{"anyOf":[{"type":"integer"},{"type":"null"}]},"uniqueUsers24hUsed":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."}},"/v1/accounts/{AC}/senders/{WA}":{"get":{"summary":"Fetch a WhatsApp sender","tags":["senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","wabaSid","status","health","readiness","registrationState","twoFactor","restriction","disconnect","billingMode","pairRate","providerFactsVerifiedAt","lastSyncedAt","lastEvent","providerNumberStatus","providerStorageRegion","displayPhoneNumber","displayName","qualityRating","throughputMps","throughputUpgradeState","throughputUpgradeStartedAt","nameStatus","officialBusinessAccount","coexistence","coexistenceSync","capabilities","provider","portfolioOwnership","providerEstate","refreshedAt","callingSettings","flowsPublicKeyState","webhookOverride","limits","statusCallbackUrl","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender"]},"sid":{"type":"string"},"wabaSid":{"type":"string"},"status":{"type":"string"},"health":{"type":"string"},"readiness":{"type":"object","required":["state","blockers","attention"],"properties":{"state":{"anyOf":[{"type":"string","enum":["ready"]},{"type":"string","enum":["attention"]},{"type":"string","enum":["blocked"]}]},"blockers":{"type":"array","items":{"type":"string"}},"attention":{"type":"array","items":{"type":"string"}}}},"registrationState":{"type":"string"},"twoFactor":{"type":"object","required":["state","updatedAt"],"properties":{"state":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"restriction":{"anyOf":[{"type":"object","required":["class","endsAt"],"properties":{"class":{"type":"string"},"endsAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"disconnect":{"anyOf":[{"type":"object","required":["reason","initiator","at"],"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"initiator":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"billingMode":{"type":"string"},"pairRate":{"type":"object","required":["deferredMessages"],"properties":{"deferredMessages":{"type":"integer"}}},"providerFactsVerifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSyncedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastEvent":{"anyOf":[{"type":"object","required":["field","receivedAt"],"properties":{"field":{"type":"string"},"receivedAt":{"type":"string"}}},{"type":"null"}]},"providerNumberStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerStorageRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayPhoneNumber":{"type":"string"},"displayName":{"type":"string"},"qualityRating":{"type":"string"},"throughputMps":{"type":"integer"},"throughputUpgradeState":{"type":"string"},"throughputUpgradeStartedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"nameStatus":{"type":"string"},"officialBusinessAccount":{"type":"boolean"},"coexistence":{"type":"boolean"},"coexistenceSync":{"anyOf":[{"type":"object","required":["state","requestedAt","deadlineAt","completedAt","progressPercent","phase","messagesImported","messagesSkipped","contactsImported","historySharingDeclined","lastChunkAt"],"properties":{"state":{"type":"string"},"requestedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deadlineAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"progressPercent":{"anyOf":[{"type":"integer"},{"type":"null"}]},"phase":{"anyOf":[{"type":"integer"},{"type":"null"}]},"messagesImported":{"type":"integer"},"messagesSkipped":{"type":"integer"},"contactsImported":{"type":"integer"},"historySharingDeclined":{"type":"boolean"},"lastChunkAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"capabilities":{"additionalProperties":true,"type":"object","properties":{}},"provider":{"type":"string","enum":["META_WHATSAPP"]},"portfolioOwnership":{"type":"string"},"providerEstate":{"type":"object","required":["managedBy","canManage","canRegister"],"properties":{"managedBy":{"anyOf":[{"type":"string","enum":["customer"]},{"type":"string","enum":["shipmsg"]}]},"canManage":{"type":"boolean"},"canRegister":{"type":"boolean"}}},"refreshedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"callingSettings":{"additionalProperties":true,"type":"object","properties":{}},"flowsPublicKeyState":{"type":"string"},"webhookOverride":{"type":"object","required":["callbackUri","state","verifiedAt"],"properties":{"callbackUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"limits":{"type":"object","required":["uniqueUsers24h","uniqueUsers24hUsed"],"properties":{"uniqueUsers24h":{"anyOf":[{"type":"integer"},{"type":"null"}]},"uniqueUsers24hUsed":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."},"patch":{"summary":"Update sender management settings","tags":["senders","operations"],"description":"A display-name change creates a durable Operation. statusCallbackUrl is a local verified-endpoint binding. Calling settings fail closed until Meta publishes an exact supported versioned write contract.\n\nRequired scope: `senders:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"displayName":{"minLength":1,"maxLength":256,"type":"string"},"statusCallbackUrl":{"anyOf":[{"format":"uri","maxLength":2048,"type":"string"},{"type":"null"}]},"callingSettings":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","wabaSid","status","health","readiness","registrationState","twoFactor","restriction","disconnect","billingMode","pairRate","providerFactsVerifiedAt","lastSyncedAt","lastEvent","providerNumberStatus","providerStorageRegion","displayPhoneNumber","displayName","qualityRating","throughputMps","throughputUpgradeState","throughputUpgradeStartedAt","nameStatus","officialBusinessAccount","coexistence","coexistenceSync","capabilities","provider","portfolioOwnership","providerEstate","refreshedAt","callingSettings","flowsPublicKeyState","webhookOverride","limits","statusCallbackUrl","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender"]},"sid":{"type":"string"},"wabaSid":{"type":"string"},"status":{"type":"string"},"health":{"type":"string"},"readiness":{"type":"object","required":["state","blockers","attention"],"properties":{"state":{"anyOf":[{"type":"string","enum":["ready"]},{"type":"string","enum":["attention"]},{"type":"string","enum":["blocked"]}]},"blockers":{"type":"array","items":{"type":"string"}},"attention":{"type":"array","items":{"type":"string"}}}},"registrationState":{"type":"string"},"twoFactor":{"type":"object","required":["state","updatedAt"],"properties":{"state":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"restriction":{"anyOf":[{"type":"object","required":["class","endsAt"],"properties":{"class":{"type":"string"},"endsAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"disconnect":{"anyOf":[{"type":"object","required":["reason","initiator","at"],"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"initiator":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"billingMode":{"type":"string"},"pairRate":{"type":"object","required":["deferredMessages"],"properties":{"deferredMessages":{"type":"integer"}}},"providerFactsVerifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSyncedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastEvent":{"anyOf":[{"type":"object","required":["field","receivedAt"],"properties":{"field":{"type":"string"},"receivedAt":{"type":"string"}}},{"type":"null"}]},"providerNumberStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerStorageRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayPhoneNumber":{"type":"string"},"displayName":{"type":"string"},"qualityRating":{"type":"string"},"throughputMps":{"type":"integer"},"throughputUpgradeState":{"type":"string"},"throughputUpgradeStartedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"nameStatus":{"type":"string"},"officialBusinessAccount":{"type":"boolean"},"coexistence":{"type":"boolean"},"coexistenceSync":{"anyOf":[{"type":"object","required":["state","requestedAt","deadlineAt","completedAt","progressPercent","phase","messagesImported","messagesSkipped","contactsImported","historySharingDeclined","lastChunkAt"],"properties":{"state":{"type":"string"},"requestedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deadlineAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"progressPercent":{"anyOf":[{"type":"integer"},{"type":"null"}]},"phase":{"anyOf":[{"type":"integer"},{"type":"null"}]},"messagesImported":{"type":"integer"},"messagesSkipped":{"type":"integer"},"contactsImported":{"type":"integer"},"historySharingDeclined":{"type":"boolean"},"lastChunkAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"capabilities":{"additionalProperties":true,"type":"object","properties":{}},"provider":{"type":"string","enum":["META_WHATSAPP"]},"portfolioOwnership":{"type":"string"},"providerEstate":{"type":"object","required":["managedBy","canManage","canRegister"],"properties":{"managedBy":{"anyOf":[{"type":"string","enum":["customer"]},{"type":"string","enum":["shipmsg"]}]},"canManage":{"type":"boolean"},"canRegister":{"type":"boolean"}}},"refreshedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"callingSettings":{"additionalProperties":true,"type":"object","properties":{}},"flowsPublicKeyState":{"type":"string"},"webhookOverride":{"type":"object","required":["callbackUri","state","verifiedAt"],"properties":{"callbackUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string"},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"limits":{"type":"object","required":["uniqueUsers24h","uniqueUsers24hUsed"],"properties":{"uniqueUsers24h":{"anyOf":[{"type":"integer"},{"type":"null"}]},"uniqueUsers24hUsed":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"]},"delete":{"summary":"Remove a sender locally without changing Meta assets","tags":["senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/senders/{WA}/verify":{"post":{"summary":"Request or submit a sender verification code","tags":["senders","operations"],"description":"Creates a REGISTER Operation; verification codes are stored only as short-lived encrypted envelopes.\n\nRequired scope: `senders:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"additionalProperties":false,"type":"object","required":["codeMethod","locale"],"properties":{"codeMethod":{"anyOf":[{"type":"string","enum":["sms"]},{"type":"string","enum":["voice"]}]},"locale":{"pattern":"^[a-z]{2,3}_[A-Z]{2}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["code"],"properties":{"code":{"pattern":"^[0-9]{1,16}$","type":"string"}}}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"]}},"/v1/accounts/{AC}/senders/{WA}/opt-out-config":{"get":{"summary":"Fetch sender opt-out keyword configuration","tags":["senders","contacts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["object","senderSid"],"properties":{"object":{"type":"string","enum":["sender_opt_out_config"]},"senderSid":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["enabled","optOutKeywords","optInKeywords","matchMode","scopeOnOptOut","confirmation","languages"],"properties":{"enabled":{"type":"boolean"},"optOutKeywords":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"optInKeywords":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"excludedKeywords":{"maxItems":200,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"matchMode":{"anyOf":[{"type":"string","enum":["tolerant"]},{"type":"string","enum":["exact"]},{"type":"string","enum":["starts_with"]},{"type":"string","enum":["contains"]}]},"scopeOnOptOut":{"anyOf":[{"type":"string","enum":["marketing"]},{"type":"string","enum":["all"]}]},"confirmation":{"anyOf":[{"additionalProperties":false,"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","enum":[false]}}},{"additionalProperties":false,"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","enum":[true]}}},{"additionalProperties":false,"type":"object","required":["enabled","templateSid"],"properties":{"enabled":{"type":"boolean","enum":[true]},"templateSid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["enabled","text"],"properties":{"enabled":{"type":"boolean","enum":[true]},"text":{"minLength":1,"maxLength":4096,"type":"string"}}}]},"confirmationTexts":{"type":"object","additionalProperties":{"minLength":1,"maxLength":1024,"type":"string"}},"languages":{"maxItems":50,"uniqueItems":true,"type":"array","items":{"minLength":2,"maxLength":35,"type":"string"}}}},{"type":"object","required":["effectiveOptOutKeywords","effectiveOptInKeywords","effectiveConfirmationTexts","supportedLanguages","updatedAt"],"properties":{"effectiveOptOutKeywords":{"type":"array","items":{"type":"object","required":["keyword","languages","custom"],"properties":{"keyword":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"custom":{"type":"boolean"}}}},"effectiveOptInKeywords":{"type":"array","items":{"type":"object","required":["keyword","languages","custom"],"properties":{"keyword":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"custom":{"type":"boolean"}}}},"effectiveConfirmationTexts":{"type":"object","additionalProperties":{"type":"string"}},"supportedLanguages":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string"}}}]}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."},"put":{"summary":"Replace sender opt-out keyword configuration","tags":["senders","contacts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","optOutKeywords","optInKeywords","matchMode","scopeOnOptOut","confirmation","languages"],"properties":{"enabled":{"type":"boolean"},"optOutKeywords":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"optInKeywords":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"excludedKeywords":{"maxItems":200,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"matchMode":{"anyOf":[{"type":"string","enum":["tolerant"]},{"type":"string","enum":["exact"]},{"type":"string","enum":["starts_with"]},{"type":"string","enum":["contains"]}]},"scopeOnOptOut":{"anyOf":[{"type":"string","enum":["marketing"]},{"type":"string","enum":["all"]}]},"confirmation":{"anyOf":[{"additionalProperties":false,"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","enum":[false]}}},{"additionalProperties":false,"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","enum":[true]}}},{"additionalProperties":false,"type":"object","required":["enabled","templateSid"],"properties":{"enabled":{"type":"boolean","enum":[true]},"templateSid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["enabled","text"],"properties":{"enabled":{"type":"boolean","enum":[true]},"text":{"minLength":1,"maxLength":4096,"type":"string"}}}]},"confirmationTexts":{"type":"object","additionalProperties":{"minLength":1,"maxLength":1024,"type":"string"}},"languages":{"maxItems":50,"uniqueItems":true,"type":"array","items":{"minLength":2,"maxLength":35,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["object","senderSid"],"properties":{"object":{"type":"string","enum":["sender_opt_out_config"]},"senderSid":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["enabled","optOutKeywords","optInKeywords","matchMode","scopeOnOptOut","confirmation","languages"],"properties":{"enabled":{"type":"boolean"},"optOutKeywords":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"optInKeywords":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"excludedKeywords":{"maxItems":200,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"matchMode":{"anyOf":[{"type":"string","enum":["tolerant"]},{"type":"string","enum":["exact"]},{"type":"string","enum":["starts_with"]},{"type":"string","enum":["contains"]}]},"scopeOnOptOut":{"anyOf":[{"type":"string","enum":["marketing"]},{"type":"string","enum":["all"]}]},"confirmation":{"anyOf":[{"additionalProperties":false,"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","enum":[false]}}},{"additionalProperties":false,"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","enum":[true]}}},{"additionalProperties":false,"type":"object","required":["enabled","templateSid"],"properties":{"enabled":{"type":"boolean","enum":[true]},"templateSid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["enabled","text"],"properties":{"enabled":{"type":"boolean","enum":[true]},"text":{"minLength":1,"maxLength":4096,"type":"string"}}}]},"confirmationTexts":{"type":"object","additionalProperties":{"minLength":1,"maxLength":1024,"type":"string"}},"languages":{"maxItems":50,"uniqueItems":true,"type":"array","items":{"minLength":2,"maxLength":35,"type":"string"}}}},{"type":"object","required":["effectiveOptOutKeywords","effectiveOptInKeywords","effectiveConfirmationTexts","supportedLanguages","updatedAt"],"properties":{"effectiveOptOutKeywords":{"type":"array","items":{"type":"object","required":["keyword","languages","custom"],"properties":{"keyword":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"custom":{"type":"boolean"}}}},"effectiveOptInKeywords":{"type":"array","items":{"type":"object","required":["keyword","languages","custom"],"properties":{"keyword":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"custom":{"type":"boolean"}}}},"effectiveConfirmationTexts":{"type":"object","additionalProperties":{"type":"string"}},"supportedLanguages":{"type":"array","items":{"type":"string"}},"updatedAt":{"type":"string"}}}]}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/senders/{WA}/deregister":{"post":{"summary":"Deregister a Cloud API sender","tags":["senders","operations"],"description":"Creates a monitored DEREGISTER Operation. Coexistence numbers cannot be deregistered. §109.6: the provider decides the final state, so the answer is 200 with `outcome: unknown` and `resolutionBy` naming the Operation to watch.\n\nRequired scope: `senders:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"]}},"/v1/accounts/{AC}/senders/{WA}/two-step-pin":{"post":{"summary":"Rotate the sender two-step verification PIN","tags":["senders","operations"],"description":"Creates a monitored REGISTER Operation running the §12.3 SET_TWO_STEP command. The PIN is sealed through the credential broker and is never returned or logged.\n\nRequired scope: `senders:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"pin":{"pattern":"^[0-9]{6}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"]}},"/v1/accounts/{AC}/wabas/{WB}/disconnect":{"post":{"summary":"Disconnect a WABA and fence all of its senders","tags":["senders","onboarding"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["confirmDisplayName","stepUpEvidence"],"properties":{"confirmDisplayName":{"minLength":1,"maxLength":256,"type":"string"},"stepUpEvidence":{"minLength":16,"maxLength":4096,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["wabas:write"],"description":"Required scope: `wabas:write`."}},"/v1/accounts/{AC}/senders/{WA}/flows/keys":{"post":{"summary":"Generate, upload and verify a sender Flow encryption key","tags":["senders","flows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/sender-pools":{"post":{"summary":"Create a sender pool","tags":["senders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","senderSids","strategy"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"senderSids":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"strategy":{"anyOf":[{"type":"string","enum":["round_robin"]},{"type":"string","enum":["least_loaded"]},{"type":"string","enum":["sticky_contact"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","name","senderSids","strategy","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender_pool"]},"sid":{"type":"string"},"name":{"type":"string"},"senderSids":{"type":"array","items":{"type":"string"}},"strategy":{"anyOf":[{"type":"string","enum":["round_robin"]},{"type":"string","enum":["least_loaded"]},{"type":"string","enum":["sticky_contact"]}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."},"get":{"summary":"List sender pools","tags":["senders"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","name","senderSids","strategy","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender_pool"]},"sid":{"type":"string"},"name":{"type":"string"},"senderSids":{"type":"array","items":{"type":"string"}},"strategy":{"anyOf":[{"type":"string","enum":["round_robin"]},{"type":"string","enum":["least_loaded"]},{"type":"string","enum":["sticky_contact"]}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."}},"/v1/accounts/{AC}/sender-pools/{SP}":{"get":{"summary":"Fetch a sender pool","tags":["senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","name","senderSids","strategy","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender_pool"]},"sid":{"type":"string"},"name":{"type":"string"},"senderSids":{"type":"array","items":{"type":"string"}},"strategy":{"anyOf":[{"type":"string","enum":["round_robin"]},{"type":"string","enum":["least_loaded"]},{"type":"string","enum":["sticky_contact"]}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."},"patch":{"summary":"Update a sender pool","tags":["senders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"senderSids":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"strategy":{"anyOf":[{"type":"string","enum":["round_robin"]},{"type":"string","enum":["least_loaded"]},{"type":"string","enum":["sticky_contact"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","name","senderSids","strategy","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["sender_pool"]},"sid":{"type":"string"},"name":{"type":"string"},"senderSids":{"type":"array","items":{"type":"string"}},"strategy":{"anyOf":[{"type":"string","enum":["round_robin"]},{"type":"string","enum":["least_loaded"]},{"type":"string","enum":["sticky_contact"]}]},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."},"delete":{"summary":"Delete a sender pool","tags":["senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SP","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/senders/{WA}/webhook-override":{"get":{"summary":"Read the phone-level webhook override of a sender (§24.4)","tags":["senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","senderSid","wabaSid","overrideCallbackUri","state","verifiedAt","effectiveLevel"],"properties":{"object":{"type":"string","enum":["sender_webhook_override"]},"senderSid":{"type":"string"},"wabaSid":{"type":"string"},"overrideCallbackUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["unset"]},{"type":"string","enum":["pending"]},{"type":"string","enum":["configured"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["removed"]}]},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"effectiveLevel":{"anyOf":[{"type":"string","enum":["phone_number"]},{"type":"string","enum":["waba_or_app"]}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:read"],"description":"Required scope: `senders:read`."},"patch":{"summary":"Set or clear the phone-level webhook override of a sender (§24.4)","tags":["senders"],"description":"Records the desired phone-level webhook_configuration and queues the SENDER_WEBHOOK_OVERRIDE management job that writes it to Meta. Phone-level takes precedence over the WABA-level override and the app default; the daily subscription reconcile keeps it converged.\n\nRequired scope: `senders:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["overrideCallbackUri"],"properties":{"overrideCallbackUri":{"anyOf":[{"pattern":"^https://","minLength":9,"maxLength":2048,"type":"string"},{"type":"null"}]},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","senderSid","wabaSid","overrideCallbackUri","state","verifiedAt","effectiveLevel"],"properties":{"object":{"type":"string","enum":["sender_webhook_override"]},"senderSid":{"type":"string"},"wabaSid":{"type":"string"},"overrideCallbackUri":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["unset"]},{"type":"string","enum":["pending"]},{"type":"string","enum":["configured"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["removed"]}]},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"effectiveLevel":{"anyOf":[{"type":"string","enum":["phone_number"]},{"type":"string","enum":["waba_or_app"]}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"]}},"/v1/accounts/{AC}/messages/bulk-cancel":{"post":{"summary":"Cancel up to 100 messages","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["messageSids","reason"],"properties":{"messageSids":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"reason":{"minLength":1,"maxLength":1000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","action","results"],"properties":{"object":{"type":"string","enum":["message_bulk_action"]},"action":{"anyOf":[{"type":"string","enum":["cancel"]},{"type":"string","enum":["redact"]}]},"results":{"type":"array","items":{"type":"object","required":["sid","outcome"],"properties":{"sid":{"type":"string"},"outcome":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:cancel"],"description":"Required scope: `messages:cancel`."}},"/v1/accounts/{AC}/messages/bulk-redact":{"post":{"summary":"Irreversibly redact up to 100 messages through a deletion request","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["messageSids","reason"],"properties":{"messageSids":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"reason":{"minLength":1,"maxLength":1000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","scope","state","legalHoldState","operationSid","messageSids"],"properties":{"object":{"type":"string","enum":["deletion_request"]},"sid":{"type":"string"},"scope":{"type":"string","enum":["MESSAGE_SET"]},"state":{"type":"string"},"legalHoldState":{"type":"string"},"operationSid":{"type":"string"},"messageSids":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:redact"],"description":"Required scope: `messages:redact`."}},"/v1/accounts/{AC}/messages/{SM}/read":{"post":{"summary":"Mark an inbound WhatsApp message read","tags":["messages","commands"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SM","required":true,"description":"Message SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["success"],"properties":{"success":{"type":"boolean","enum":[true]}}},"example":{"success":true}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:write"],"description":"Mark an inbound message as read, which shows the blue ticks to the sender.\n\nRequired scope: `messages:write`."}},"/v1/accounts/{AC}/messages/{SM}/typing":{"post":{"summary":"Send a WhatsApp typing indicator and mark the inbound message read","tags":["messages","commands"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SM","required":true,"description":"Message SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["success"],"properties":{"success":{"type":"boolean","enum":[true]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:write"],"description":"Required scope: `messages:write`."}},"/v1/accounts/{AC}/senders/{WA}/block-users":{"post":{"summary":"Block WhatsApp users","tags":["senders","commands"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["users"],"properties":{"users":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":7,"maxLength":64,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["success"],"properties":{"success":{"type":"boolean","enum":[true]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."},"delete":{"summary":"Unblock WhatsApp users","tags":["senders","commands"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["users"],"properties":{"users":{"minItems":1,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":7,"maxLength":64,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["success"],"properties":{"success":{"type":"boolean","enum":[true]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["senders:write"],"description":"Required scope: `senders:write`."}},"/v1/accounts/{AC}/messages/batch":{"post":{"summary":"Create up to 1,000 messages with independent per-item admission","tags":["messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["messages"],"properties":{"messages":{"minItems":1,"maxItems":1000,"type":"array","items":{"additionalProperties":false,"type":"object","properties":{"conversationSid":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID for an agent inbox reply","type":"string"},"composerClaimToken":{"format":"uuid","type":"string"},"composerOverrideReason":{"minLength":1,"maxLength":1000,"type":"string"},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"senderPoolSid":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender pool SID","type":"string"},"to":{"description":"E.164 recipient (whatsapp: prefix accepted and stripped)","maxLength":32,"type":"string"},"recipient":{"additionalProperties":false,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"anyOf":[{"type":"string","enum":["phone_e164"]},{"type":"string","enum":["bsuid"]},{"type":"string","enum":["username"]}]},"value":{"minLength":1,"maxLength":64,"type":"string"}}},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","description":"Contact SID; addresses an existing contact directly (§101.3)","type":"string"},"defaultCountry":{"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country used to read a national phone number (NG reads 08031234567 as +2348031234567). Without it the number must start with + or 00.","type":"string"},"type":{"anyOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["template"]},{"type":"string","enum":["image"]},{"type":"string","enum":["video"]},{"type":"string","enum":["audio"]},{"type":"string","enum":["document"]},{"type":"string","enum":["sticker"]},{"type":"string","enum":["location"]},{"type":"string","enum":["contacts"]},{"type":"string","enum":["reaction"]},{"type":"string","enum":["interactive"]},{"type":"string","enum":["product"]},{"type":"string","enum":["catalog"]},{"type":"string","enum":["flow"]},{"type":"string","enum":["product_list"]},{"type":"string","enum":["address"]},{"type":"string","enum":["carousel"]}]},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","description":"Reusable content SID; alternative to type/template","type":"string"},"variables":{"maxProperties":100,"type":"object","additionalProperties":{"maxLength":4096,"type":"string"}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":false,"type":"object","required":["name","language"],"properties":{"name":{"minLength":1,"maxLength":512,"type":"string"},"language":{"minLength":2,"maxLength":16,"type":"string"},"components":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["type"],"properties":{"type":{"anyOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["body"]},{"type":"string","enum":["button"]},{"type":"string","enum":["limited_time_offer"]},{"type":"string","enum":["tap_target_configuration"]}]},"subType":{"anyOf":[{"type":"string","enum":["quick_reply"]},{"type":"string","enum":["url"]},{"type":"string","enum":["copy_code"]},{"type":"string","enum":["otp"]},{"type":"string","enum":["catalog"]},{"type":"string","enum":["flow"]},{"type":"string","enum":["mpm"]},{"type":"string","enum":["spm"]}]},"index":{"minimum":0,"maximum":9,"type":"integer"},"parameters":{"type":"array","items":{"anyOf":[{"additionalProperties":false,"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"]},"text":{"maxLength":1024,"type":"string"},"parameterName":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","fallbackValue","code","amount1000"],"properties":{"type":{"type":"string","enum":["currency"]},"fallbackValue":{"type":"string"},"code":{"minLength":3,"maxLength":3,"type":"string"},"amount1000":{"type":"integer"}}},{"additionalProperties":false,"type":"object","required":["type","fallbackValue"],"properties":{"type":{"type":"string","enum":["date_time"]},"fallbackValue":{"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","enum":["payload"]},"payload":{"maxLength":256,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["image"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY image media SID","type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["video"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY video media SID","type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","sid"],"properties":{"type":{"type":"string","enum":["document"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"READY document media SID","type":"string"},"filename":{"minLength":1,"maxLength":255,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","latitude","longitude"],"properties":{"type":{"type":"string","enum":["location"]},"latitude":{"minimum":-90,"maximum":90,"type":"number"},"longitude":{"minimum":-180,"maximum":180,"type":"number"},"name":{"maxLength":1000,"type":"string"},"address":{"maxLength":1000,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","couponCode"],"properties":{"type":{"type":"string","enum":["coupon_code"]},"couponCode":{"minLength":1,"maxLength":15,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type","expirationTimeMs"],"properties":{"type":{"type":"string","enum":["limited_time_offer"]},"expirationTimeMs":{"minimum":1,"description":"When the offer ends (epoch ms)","type":"integer"}}},{"additionalProperties":false,"type":"object","required":["type","url","title"],"properties":{"type":{"type":"string","enum":["tap_target_configuration"]},"url":{"format":"uri","maxLength":2000,"type":"string"},"title":{"minLength":1,"maxLength":60,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["action"]},"thumbnailProductRetailerId":{"minLength":1,"maxLength":256,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},{"additionalProperties":false,"type":"object","required":["type","catalogId","productRetailerId"],"properties":{"type":{"type":"string","enum":["product"]},"catalogId":{"minLength":1,"maxLength":256,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}]}}}}}}},"media":{"additionalProperties":false,"type":"object","required":["sid"],"properties":{"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"Media SID; must be READY","type":"string"},"caption":{"maxLength":1024,"type":"string"},"filename":{"minLength":1,"maxLength":255,"type":"string"},"voice":{"type":"boolean"}}},"location":{"additionalProperties":false,"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"minimum":-90,"maximum":90,"type":"number"},"longitude":{"minimum":-180,"maximum":180,"type":"number"},"name":{"maxLength":1000,"type":"string"},"address":{"maxLength":1000,"type":"string"}}},"contacts":{"additionalProperties":false,"type":"object","required":["contacts"],"properties":{"contacts":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["formattedName"],"properties":{"formattedName":{"minLength":1,"maxLength":256,"type":"string"},"firstName":{"maxLength":128,"type":"string"},"lastName":{"maxLength":128,"type":"string"},"phones":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["value"],"properties":{"value":{"minLength":1,"maxLength":32,"type":"string"},"type":{"maxLength":32,"type":"string"}}}},"emails":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["value"],"properties":{"value":{"minLength":3,"maxLength":320,"type":"string"},"type":{"maxLength":32,"type":"string"}}}}}}}}},"reaction":{"additionalProperties":false,"type":"object","required":["targetMessageId","emoji"],"properties":{"targetMessageId":{"minLength":1,"maxLength":256,"type":"string"},"emoji":{"maxLength":16,"type":"string"}}},"interactive":{"anyOf":[{"additionalProperties":false,"type":"object","required":["subtype","body","buttons"],"properties":{"subtype":{"type":"string","enum":["button"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"buttons":{"minItems":1,"maxItems":3,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","title"],"properties":{"id":{"minLength":1,"maxLength":256,"type":"string"},"title":{"minLength":1,"maxLength":20,"type":"string"}}}}}},{"additionalProperties":false,"type":"object","required":["subtype","body","button","sections"],"properties":{"subtype":{"type":"string","enum":["list"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"button":{"minLength":1,"maxLength":20,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["rows"],"properties":{"title":{"maxLength":24,"type":"string"},"rows":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","title"],"properties":{"id":{"minLength":1,"maxLength":200,"type":"string"},"title":{"minLength":1,"maxLength":24,"type":"string"},"description":{"maxLength":72,"type":"string"}}}}}}}}},{"additionalProperties":false,"type":"object","required":["subtype","body","displayText","url"],"properties":{"subtype":{"type":"string","enum":["cta_url"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"displayText":{"minLength":1,"maxLength":20,"type":"string"},"url":{"format":"uri","maxLength":2048,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["subtype","body"],"properties":{"subtype":{"type":"string","enum":["location_request"]},"body":{"minLength":1,"maxLength":1024,"type":"string"}}},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["catalogId","header","sections"],"properties":{"subtype":{"type":"string","enum":["product_list"]},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"header":{"minLength":1,"maxLength":60,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["product_list"]}}}]},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["body","country"],"properties":{"subtype":{"type":"string","enum":["address"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"country":{"anyOf":[{"type":"string","enum":["IN"]},{"type":"string","enum":["SG"]}]},"values":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"validationErrors":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"savedAddresses":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","value"],"properties":{"id":{"minLength":1,"maxLength":128,"type":"string"},"value":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["address"]}}}]},{"type":"object","allOf":[{"additionalProperties":false,"type":"object","required":["body","cards"],"properties":{"subtype":{"type":"string","enum":["carousel"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"cards":{"minItems":2,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["cardIndex","catalogId","productRetailerId"],"properties":{"cardIndex":{"minimum":0,"maximum":9,"type":"integer"},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}},{"type":"object","required":["subtype"],"properties":{"subtype":{"type":"string","enum":["carousel"]}}}]}]},"product":{"additionalProperties":false,"type":"object","required":["catalogId","productRetailerId"],"properties":{"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"}}},"catalog":{"additionalProperties":false,"type":"object","required":["catalogId","body"],"properties":{"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"body":{"minLength":1,"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"thumbnailProductRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}},"flow":{"additionalProperties":false,"type":"object","required":["flowSid","body","ctaText"],"properties":{"flowSid":{"pattern":"^FL[0-9A-HJKMNP-TV-Z]{26}$","description":"Published Flow SID","type":"string"},"body":{"minLength":1,"maxLength":1024,"type":"string"},"ctaText":{"minLength":1,"maxLength":20,"type":"string"},"action":{"anyOf":[{"type":"string","enum":["navigate"]},{"type":"string","enum":["data_exchange"]}]},"screen":{"minLength":1,"maxLength":128,"type":"string"},"data":{"additionalProperties":true,"type":"object","properties":{}}}},"productList":{"additionalProperties":false,"type":"object","required":["catalogId","header","sections"],"properties":{"subtype":{"type":"string","enum":["product_list"]},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"header":{"minLength":1,"maxLength":60,"type":"string"},"body":{"maxLength":1024,"type":"string"},"footer":{"maxLength":60,"type":"string"},"sections":{"minItems":1,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["title","productItems"],"properties":{"title":{"minLength":1,"maxLength":24,"type":"string"},"productItems":{"minItems":1,"maxItems":30,"type":"array","items":{"additionalProperties":false,"type":"object","required":["productRetailerId"],"properties":{"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}}}}},"address":{"additionalProperties":false,"type":"object","required":["body","country"],"properties":{"subtype":{"type":"string","enum":["address"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"country":{"anyOf":[{"type":"string","enum":["IN"]},{"type":"string","enum":["SG"]}]},"values":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"validationErrors":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}},"savedAddresses":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id","value"],"properties":{"id":{"minLength":1,"maxLength":128,"type":"string"},"value":{"type":"object","additionalProperties":{"maxLength":1024,"type":"string"}}}}}}},"carousel":{"additionalProperties":false,"type":"object","required":["body","cards"],"properties":{"subtype":{"type":"string","enum":["carousel"]},"body":{"minLength":1,"maxLength":1024,"type":"string"},"cards":{"minItems":2,"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["cardIndex","catalogId","productRetailerId"],"properties":{"cardIndex":{"minimum":0,"maximum":9,"type":"integer"},"catalogId":{"minLength":1,"maxLength":128,"type":"string"},"productRetailerId":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"context":{"additionalProperties":false,"type":"object","properties":{"replyToMessageId":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"providerMessageId":{"maxLength":256,"type":"string"}}},"priority":{"anyOf":[{"type":"string","enum":["P0"]},{"type":"string","enum":["P1"]},{"type":"string","enum":["P2"]},{"type":"string","enum":["P3"]}]},"sendAt":{"format":"date-time","description":"RFC 3339; ≤ 35 days ahead","type":"string"},"validityPeriodSeconds":{"minimum":30,"maximum":2592000,"type":"integer"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":false,"type":"object","properties":{"ttlSeconds":{"minimum":43200,"maximum":2592000,"type":"integer"}}},"deferIfCapped":{"description":"Defer marketing sends until a recipient cap clears","type":"boolean"},"category":{"description":"Derived from the template when absent; must match it when present (§13A.3)","anyOf":[{"type":"string","enum":["authentication"]},{"type":"string","enum":["utility"]},{"type":"string","enum":["marketing"]},{"type":"string","enum":["service"]}]},"statusCallbackUrl":{"format":"uri","maxLength":2048,"type":"string"},"statusCallbackSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","description":"Verified webhook endpoint SID; alternative to statusCallbackUrl (§13)","type":"string"},"metadata":{"maxProperties":16,"type":"object","additionalProperties":{"maxLength":512,"type":"string"}},"tags":{"maxItems":10,"type":"array","items":{"maxLength":40,"type":"string"}}}}}}},"example":{"messages":[{"from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":"+14155550123","type":"text","text":{"body":"Your table is ready."}},{"from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":"+14155550124","type":"template","contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3"}]}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","status","total","accepted","failed","countsByStatus","createdAt","completedAt"],"properties":{"object":{"type":"string","enum":["message_batch"]},"sid":{"pattern":"^MB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"status":{"anyOf":[{"type":"string","enum":["processing"]},{"type":"string","enum":["completed"]}]},"total":{"type":"integer"},"accepted":{"type":"integer"},"failed":{"type":"integer"},"countsByStatus":{"type":"object","additionalProperties":{"type":"integer"}},"results":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["index"],"properties":{"index":{"type":"integer"},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"error":{"additionalProperties":true,"type":"object","properties":{}}}}},"createdAt":{"type":"string"},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"message_batch","sid":"MB01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"processing","total":1,"accepted":1,"failed":1,"countsByStatus":{},"createdAt":"createdAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:send"],"description":"Send up to 1,000 messages in one request. Each item is admitted or refused on its own; the response reports each item's outcome and a batch SID to follow progress.\n\nRequired scope: `messages:send`."}},"/v1/accounts/{AC}/messages/batches/{MB}":{"get":{"summary":"Fetch message batch counts","tags":["messages"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^MB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"MB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","status","total","accepted","failed","countsByStatus","createdAt","completedAt"],"properties":{"object":{"type":"string","enum":["message_batch"]},"sid":{"pattern":"^MB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"status":{"anyOf":[{"type":"string","enum":["processing"]},{"type":"string","enum":["completed"]}]},"total":{"type":"integer"},"accepted":{"type":"integer"},"failed":{"type":"integer"},"countsByStatus":{"type":"object","additionalProperties":{"type":"integer"}},"results":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["index"],"properties":{"index":{"type":"integer"},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"error":{"additionalProperties":true,"type":"object","properties":{}}}}},"createdAt":{"type":"string"},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"message_batch","sid":"MB01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"processing","total":1,"accepted":1,"failed":1,"countsByStatus":{},"createdAt":"createdAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:read"],"description":"Fetch how many items of a batch were accepted, refused, sent and delivered.\n\nRequired scope: `messages:read`."}},"/v1/accounts/{AC}/messages/{SM}/cancel":{"post":{"summary":"Cancel a message before provider submission","tags":["messages"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SM","required":true,"description":"Message SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","allOf":[{"additionalProperties":true,"type":"object","required":["object","sid","status","direction","from","to","type","priority","livemode","providerMessageId","campaignSid","conversationSid","sentByPrincipal","pricing","providerAccepted","heldForQuality","providerPaused","attempt","queuedReason","readyAt","sendAt","deliverBefore","transport","transportOptions","cancelRequested","unknownSince","deletedByUser","redacted","contentUnreadable","warnings","duplicateDetected","metadata","tags","statusCallbackUrl","createdAt","updatedAt","sentAt","deliveredAt","readAt"],"properties":{"object":{"type":"string","enum":["message"]},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"status":{"description":"queued | scheduled | sending | sent | delivered | read | played | failed | canceled | expired | unknown","type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound"]},{"type":"string","enum":["inbound"]}]},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"to":{"additionalProperties":true,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"masked":{"description":"True when `value` is masked (+33 6•• •• •• 78) because the caller lacks contacts:read_identifiers (§50).","type":"boolean"}}},"type":{"type":"string"},"priority":{"type":"string"},"livemode":{"type":"boolean"},"providerMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignSid":{"anyOf":[{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","description":"Campaign SID","type":"string"},{"type":"null"}]},"conversationSid":{"anyOf":[{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID","type":"string"},{"type":"null"}]},"sentByPrincipal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","required":["category","model","customerChargeMinor","currency"],"properties":{"category":{"type":"string"},"model":{"type":"string"},"customerChargeMinor":{"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"description":"Decimal places customerChargeMinor is counted in (JPY 0, USD 2, KWD 3).","type":"integer"}}},{"type":"null"}]},"providerAccepted":{"type":"boolean"},"heldForQuality":{"type":"boolean"},"providerPaused":{"type":"boolean"},"attempt":{"type":"integer"},"queuedReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliverBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":true,"type":"object","properties":{}},"cancelRequested":{"type":"boolean"},"unknownSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedByUser":{"type":"boolean"},"redacted":{"type":"boolean"},"contentUnreadable":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}},"duplicateDetected":{"type":"boolean"},"error":{"additionalProperties":true,"type":"object","properties":{}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":true,"type":"object","properties":{}},"media":{"additionalProperties":true,"type":"object","properties":{}},"location":{"additionalProperties":true,"type":"object","properties":{}},"contacts":{"additionalProperties":true,"type":"object","properties":{}},"reaction":{"additionalProperties":true,"type":"object","properties":{}},"interactive":{"additionalProperties":true,"type":"object","properties":{}},"context":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"sentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveredAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","required":["type","occurredAt","attempt","reason"],"properties":{"type":{"type":"string"},"occurredAt":{"type":"string"},"attempt":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},{"type":"object","required":["outcome","resolutionBy"],"properties":{"outcome":{"anyOf":[{"type":"string","enum":["applied"]},{"type":"string","enum":["not_applied"]},{"type":"string","enum":["unknown"]}]},"resolutionBy":{"anyOf":[{"type":"string"},{"type":"null"}]}}}]},"example":{"object":"message","sid":"SM01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"status","direction":"outbound","from":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","to":{"identifierType":"identifierType","value":"value"},"type":"type","priority":"priority","livemode":false,"providerMessageId":"providerMessageId","campaignSid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","conversationSid":"CO01J8Z3K4M5N6P7Q8R9S0T1V2W3","sentByPrincipal":"sentByPrincipal","pricing":{"category":"category","model":"model","customerChargeMinor":1,"currency":"USD"},"providerAccepted":false,"heldForQuality":false,"providerPaused":false,"attempt":1,"queuedReason":"queuedReason","readyAt":"readyAt","sendAt":"sendAt","deliverBefore":"deliverBefore","transport":"cloud_api","transportOptions":{},"cancelRequested":false,"unknownSince":"unknownSince","deletedByUser":false,"redacted":false,"contentUnreadable":false,"warnings":["warnings"],"duplicateDetected":false,"metadata":{},"tags":["tags"],"statusCallbackUrl":"statusCallbackUrl","createdAt":"createdAt","updatedAt":"updatedAt","sentAt":"sentAt","deliveredAt":"deliveredAt","readAt":"readAt","outcome":"applied","resolutionBy":"resolutionBy"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:cancel"],"description":"Cancel a message that has not yet been handed to WhatsApp. A message already submitted cannot be recalled.\n\nRequired scope: `messages:cancel`."}},"/v1/accounts/{AC}/messages/{SM}/redact":{"post":{"summary":"Irreversibly redact message content","tags":["messages"],"description":"§29.5: requires a reason, recorded on the audit entry, and a fresh step-up grant for `MESSAGE_REDACT`, consumed in the same transaction as the redaction.\n\nRequired scope: `messages:redact`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","stepUpToken"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SM","required":true,"description":"Message SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","status","direction","from","to","type","priority","livemode","providerMessageId","campaignSid","conversationSid","sentByPrincipal","pricing","providerAccepted","heldForQuality","providerPaused","attempt","queuedReason","readyAt","sendAt","deliverBefore","transport","transportOptions","cancelRequested","unknownSince","deletedByUser","redacted","contentUnreadable","warnings","duplicateDetected","metadata","tags","statusCallbackUrl","createdAt","updatedAt","sentAt","deliveredAt","readAt"],"properties":{"object":{"type":"string","enum":["message"]},"sid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","description":"Message SID","type":"string"},"status":{"description":"queued | scheduled | sending | sent | delivered | read | played | failed | canceled | expired | unknown","type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound"]},{"type":"string","enum":["inbound"]}]},"from":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","description":"Sender SID","type":"string"},"to":{"additionalProperties":true,"type":"object","required":["identifierType","value"],"properties":{"identifierType":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"masked":{"description":"True when `value` is masked (+33 6•• •• •• 78) because the caller lacks contacts:read_identifiers (§50).","type":"boolean"}}},"type":{"type":"string"},"priority":{"type":"string"},"livemode":{"type":"boolean"},"providerMessageId":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignSid":{"anyOf":[{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","description":"Campaign SID","type":"string"},{"type":"null"}]},"conversationSid":{"anyOf":[{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","description":"Conversation SID","type":"string"},{"type":"null"}]},"sentByPrincipal":{"anyOf":[{"type":"string"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","required":["category","model","customerChargeMinor","currency"],"properties":{"category":{"type":"string"},"model":{"type":"string"},"customerChargeMinor":{"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"description":"Decimal places customerChargeMinor is counted in (JPY 0, USD 2, KWD 3).","type":"integer"}}},{"type":"null"}]},"providerAccepted":{"type":"boolean"},"heldForQuality":{"type":"boolean"},"providerPaused":{"type":"boolean"},"attempt":{"type":"integer"},"queuedReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sendAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliverBefore":{"anyOf":[{"type":"string"},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"transportOptions":{"additionalProperties":true,"type":"object","properties":{}},"cancelRequested":{"type":"boolean"},"unknownSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedByUser":{"type":"boolean"},"redacted":{"type":"boolean"},"contentUnreadable":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}},"duplicateDetected":{"type":"boolean"},"error":{"additionalProperties":true,"type":"object","properties":{}},"text":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":4096,"type":"string"},"previewUrl":{"type":"boolean"}}},"template":{"additionalProperties":true,"type":"object","properties":{}},"media":{"additionalProperties":true,"type":"object","properties":{}},"location":{"additionalProperties":true,"type":"object","properties":{}},"contacts":{"additionalProperties":true,"type":"object","properties":{}},"reaction":{"additionalProperties":true,"type":"object","properties":{}},"interactive":{"additionalProperties":true,"type":"object","properties":{}},"context":{"additionalProperties":true,"type":"object","properties":{}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"statusCallbackUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"sentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveredAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","required":["type","occurredAt","attempt","reason"],"properties":{"type":{"type":"string"},"occurredAt":{"type":"string"},"attempt":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["messages:redact"]}},"/v1/accounts/{AC}/campaign-builder-drafts":{"get":{"summary":"List resumable campaign builder drafts","tags":["campaigns"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."},"post":{"summary":"Create a resumable campaign builder draft","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","currentStep","data"],"properties":{"name":{"minLength":1,"maxLength":256,"type":"string"},"currentStep":{"minimum":1,"maximum":9,"type":"integer"},"data":{"additionalProperties":true,"type":"object","properties":{}},"version":{"minimum":1,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaign-builder-drafts/{CD}":{"get":{"summary":"Fetch a campaign builder draft","tags":["campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CD","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."},"patch":{"summary":"Save campaign builder progress","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","currentStep","data"],"properties":{"name":{"minLength":1,"maxLength":256,"type":"string"},"currentStep":{"minimum":1,"maximum":9,"type":"integer"},"data":{"additionalProperties":true,"type":"object","properties":{}},"version":{"minimum":1,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CD","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."},"delete":{"summary":"Delete a campaign builder draft","tags":["campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CD","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns":{"get":{"summary":"List campaigns and authoritative planning state","tags":["campaigns"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"in":"query","name":"state","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}},"example":{"data":[{"object":"campaign","sid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","audience":{},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variablesMapping":{},"senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"senderPoolSid":"SP01J8Z3K4M5N6P7Q8R9S0T1V2W3","schedule":{"startAt":"startAt","endAt":"endAt","quietHours":{},"timezoneMode":"SENDER"},"pacing":{"perSenderPerMinute":1,"perAccountPerMinute":1},"budgetCapMinor":1,"budgetReservedMinor":1,"headerMediaSid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","budgetMetaEstimateMinor":1,"frequencyPolicy":{"maxMessages":1,"windowHours":1,"scope":"ALL"},"currency":"USD","transport":"cloud_api","requiresApproval":false,"approvalSid":"AP01J8Z3K4M5N6P7Q8R9S0T1V2W3","state":"DRAFT","stateReason":"stateReason","statistics":{},"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","startedAt":"startedAt","completedAt":"completedAt"}],"hasMore":false,"nextCursor":"nextCursor","dataAsOf":"dataAsOf"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"List campaigns with their state and planning progress.\n\nRequired scope: `campaigns:read`."},"post":{"summary":"Create a campaign draft","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","audience","contentSid","schedule","pacing"],"properties":{"name":{"minLength":1,"maxLength":256,"type":"string"},"audience":{"anyOf":[{"additionalProperties":false,"type":"object","required":["contactSids"],"properties":{"contactSids":{"minItems":1,"maxItems":1000000,"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}},{"additionalProperties":false,"type":"object","required":["segmentSid"],"properties":{"segmentSid":{"minLength":3,"maxLength":64,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["importSid"],"properties":{"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}]},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"description":"Template placeholder → source. A source is a contact field path (displayName, locale, timezone, attributes.<key>) or `literal:<text>` for a fixed value; a placeholder with no entry reads attributes.<placeholder>. A contact whose sources resolve to no scalar is excluded with ADDRESSING_UNSUPPORTED and the failing placeholder in detail.","type":"object","additionalProperties":{"minLength":1,"maxLength":256,"type":"string"}},"senderSids":{"minItems":1,"maxItems":100,"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt"],"properties":{"startAt":{"format":"date-time","type":"string"},"endAt":{"format":"date-time","type":"string"},"quietHours":{"additionalProperties":true,"type":"object","properties":{}},"timezoneMode":{"anyOf":[{"type":"string","enum":["sender"]},{"type":"string","enum":["recipient"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute"],"properties":{"perSenderPerMinute":{"minimum":1,"maximum":1000000,"type":"integer"},"perAccountPerMinute":{"minimum":1,"maximum":1000000,"type":"integer"}}},"budgetCapMinor":{"minimum":0,"type":"integer"},"budgetCap":{"pattern":"^[0-9][0-9,]*(\\.[0-9]+)?$","maxLength":24,"description":"Budget cap in the campaign currency's own units, for example \"500\" for JPY or \"12.50\" for GBP.","type":"string"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"minimum":1,"maximum":1000,"type":"integer"},"windowHours":{"minimum":1,"maximum":8760,"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"headerMediaSid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","description":"Media sent as the header of an IMAGE, VIDEO or DOCUMENT template. Meta needs the header asset on every send; without this the asset the template was submitted with is used, and a campaign with neither cannot be submitted.","type":"string"}}},"example":{"name":"Autumn sale","audience":{"segmentSid":"SG01J8Z3K4M5N6P7Q8R9S0T1V2W3"},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"schedule":{"startAt":"2026-10-01T09:00:00.000Z","endAt":"2026-10-01T18:00:00.000Z","timezoneMode":"recipient"},"pacing":{"perSenderPerMinute":60}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"campaign","sid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","audience":{},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variablesMapping":{},"senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"senderPoolSid":"SP01J8Z3K4M5N6P7Q8R9S0T1V2W3","schedule":{"startAt":"startAt","endAt":"endAt","quietHours":{},"timezoneMode":"SENDER"},"pacing":{"perSenderPerMinute":1,"perAccountPerMinute":1},"budgetCapMinor":1,"budgetReservedMinor":1,"headerMediaSid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","budgetMetaEstimateMinor":1,"frequencyPolicy":{"maxMessages":1,"windowHours":1,"scope":"ALL"},"currency":"USD","transport":"cloud_api","requiresApproval":false,"approvalSid":"AP01J8Z3K4M5N6P7Q8R9S0T1V2W3","state":"DRAFT","stateReason":"stateReason","statistics":{},"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","startedAt":"startedAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Create a campaign draft: who receives which template, when, and how fast. Nothing is sent until the campaign is started.\n\nRequired scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/review":{"get":{"summary":"Evaluate the current campaign authorization decision without mutating it","tags":["campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."}},"/v1/accounts/{AC}/campaigns/{CP}/review/acknowledge":{"post":{"summary":"Acknowledge an allowed campaign review snapshot","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["acknowledgeLive","acknowledgeCost"],"properties":{"acknowledgeLive":{"type":"boolean"},"acknowledgeCost":{"type":"boolean"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}":{"get":{"summary":"Fetch a campaign","tags":["campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"campaign","sid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","audience":{},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variablesMapping":{},"senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"senderPoolSid":"SP01J8Z3K4M5N6P7Q8R9S0T1V2W3","schedule":{"startAt":"startAt","endAt":"endAt","quietHours":{},"timezoneMode":"SENDER"},"pacing":{"perSenderPerMinute":1,"perAccountPerMinute":1},"budgetCapMinor":1,"budgetReservedMinor":1,"headerMediaSid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","budgetMetaEstimateMinor":1,"frequencyPolicy":{"maxMessages":1,"windowHours":1,"scope":"ALL"},"currency":"USD","transport":"cloud_api","requiresApproval":false,"approvalSid":"AP01J8Z3K4M5N6P7Q8R9S0T1V2W3","state":"DRAFT","stateReason":"stateReason","statistics":{},"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","startedAt":"startedAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Fetch one campaign with its schedule, audience, counts and cost so far.\n\nRequired scope: `campaigns:read`."},"delete":{"summary":"Delete a campaign draft","tags":["campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/controls":{"patch":{"summary":"Set the frequency policy, money budget cap, account pacing and transport (§42.3)","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"minimum":1,"maximum":1000,"type":"integer"},"windowHours":{"minimum":1,"maximum":8760,"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"budgetCapMinor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}]},"budgetCap":{"anyOf":[{"pattern":"^[0-9][0-9,]*(\\.[0-9]+)?$","maxLength":24,"description":"Budget cap in the campaign currency's own units, for example \"500\" for JPY or \"12.50\" for GBP.","type":"string"},{"type":"null"}]},"perAccountPerMinute":{"anyOf":[{"minimum":1,"maximum":1000000,"type":"integer"},{"type":"null"}]},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/schedule":{"patch":{"summary":"Edit a draft or scheduled campaign window","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["startAt","endAt","timezoneMode"],"properties":{"startAt":{"format":"date-time","type":"string"},"endAt":{"format":"date-time","type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["sender"]},{"type":"string","enum":["recipient"]}]},"perSenderPerMinute":{"minimum":1,"maximum":1000000,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/withdraw":{"post":{"summary":"Withdraw a pending campaign approval request","tags":["campaigns"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/submit":{"post":{"summary":"Submit a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/approve":{"post":{"summary":"Approve a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:decide"],"description":"Required scope: `approvals:decide`."}},"/v1/accounts/{AC}/campaigns/{CP}/reject":{"post":{"summary":"Reject a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:decide"],"description":"Required scope: `approvals:decide`."}},"/v1/accounts/{AC}/campaigns/{CP}/start":{"post":{"summary":"Start a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}},"example":{"reason":"Approved by marketing"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"campaign","sid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","audience":{},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variablesMapping":{},"senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"senderPoolSid":"SP01J8Z3K4M5N6P7Q8R9S0T1V2W3","schedule":{"startAt":"startAt","endAt":"endAt","quietHours":{},"timezoneMode":"SENDER"},"pacing":{"perSenderPerMinute":1,"perAccountPerMinute":1},"budgetCapMinor":1,"budgetReservedMinor":1,"headerMediaSid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","budgetMetaEstimateMinor":1,"frequencyPolicy":{"maxMessages":1,"windowHours":1,"scope":"ALL"},"currency":"USD","transport":"cloud_api","requiresApproval":false,"approvalSid":"AP01J8Z3K4M5N6P7Q8R9S0T1V2W3","state":"DRAFT","stateReason":"stateReason","statistics":{},"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","startedAt":"startedAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Start a campaign. It must have passed review; a campaign that needs approval waits for it.\n\nRequired scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/pause":{"post":{"summary":"Pause a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}},"example":{"reason":"Checking a complaint"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"campaign","sid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","audience":{},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variablesMapping":{},"senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"senderPoolSid":"SP01J8Z3K4M5N6P7Q8R9S0T1V2W3","schedule":{"startAt":"startAt","endAt":"endAt","quietHours":{},"timezoneMode":"SENDER"},"pacing":{"perSenderPerMinute":1,"perAccountPerMinute":1},"budgetCapMinor":1,"budgetReservedMinor":1,"headerMediaSid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","budgetMetaEstimateMinor":1,"frequencyPolicy":{"maxMessages":1,"windowHours":1,"scope":"ALL"},"currency":"USD","transport":"cloud_api","requiresApproval":false,"approvalSid":"AP01J8Z3K4M5N6P7Q8R9S0T1V2W3","state":"DRAFT","stateReason":"stateReason","statistics":{},"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","startedAt":"startedAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Pause a running campaign. Messages already handed to WhatsApp still deliver.\n\nRequired scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/resume":{"post":{"summary":"Resume a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/cancel":{"post":{"summary":"Cancel a campaign","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}},"example":{"reason":"Offer withdrawn"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"campaign","sid":"CP01J8Z3K4M5N6P7Q8R9S0T1V2W3","name":"name","audience":{},"contentSid":"HX01J8Z3K4M5N6P7Q8R9S0T1V2W3","variablesMapping":{},"senderSids":["WA01J8Z3K4M5N6P7Q8R9S0T1V2W3"],"senderPoolSid":"SP01J8Z3K4M5N6P7Q8R9S0T1V2W3","schedule":{"startAt":"startAt","endAt":"endAt","quietHours":{},"timezoneMode":"SENDER"},"pacing":{"perSenderPerMinute":1,"perAccountPerMinute":1},"budgetCapMinor":1,"budgetReservedMinor":1,"headerMediaSid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","budgetMetaEstimateMinor":1,"frequencyPolicy":{"maxMessages":1,"windowHours":1,"scope":"ALL"},"currency":"USD","transport":"cloud_api","requiresApproval":false,"approvalSid":"AP01J8Z3K4M5N6P7Q8R9S0T1V2W3","state":"DRAFT","stateReason":"stateReason","statistics":{},"livemode":false,"createdAt":"createdAt","updatedAt":"updatedAt","startedAt":"startedAt","completedAt":"completedAt"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Cancel a campaign. Recipients not yet sent to are skipped; this cannot be undone.\n\nRequired scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/dry-run":{"post":{"summary":"Dry-run campaign admission","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":512,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","type","state","progress","currentStep","steps","resultUrl","error","retryEligible","cancelRequested","blocker","attempt","input","createdBy","livemode","createdAt","updatedAt","startedAt","endedAt","expiresAt"],"properties":{"object":{"type":"string","enum":["operation"]},"sid":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","description":"Operation SID","type":"string"},"type":{"anyOf":[{"type":"string","enum":["ONBOARD_SENDER"]},{"type":"string","enum":["REGISTER"]},{"type":"string","enum":["DEREGISTER"]},{"type":"string","enum":["DISPLAY_NAME"]},{"type":"string","enum":["NUMBER_MIGRATION"]},{"type":"string","enum":["TEMPLATE_SUBMIT"]},{"type":"string","enum":["TEMPLATE_EDIT"]},{"type":"string","enum":["TEMPLATE_DELETE"]},{"type":"string","enum":["TEMPLATE_MIGRATION"]},{"type":"string","enum":["IMPORT"]},{"type":"string","enum":["EXPORT"]},{"type":"string","enum":["CAMPAIGN_DRY_RUN"]},{"type":"string","enum":["CAMPAIGN_TEST_SEND"]},{"type":"string","enum":["BILLING_MODE_SWITCH"]},{"type":"string","enum":["SANDBOX_RESET"]},{"type":"string","enum":["DELETION"]},{"type":"string","enum":["WABA_DISCONNECT"]},{"type":"string","enum":["FLOWS_KEY_UPLOAD"]},{"type":"string","enum":["FLOW_PUBLISH"]},{"type":"string","enum":["FLOW_DEPRECATE"]},{"type":"string","enum":["PRIVACY_REQUEST"]},{"type":"string","enum":["ACCOUNT_SUSPENSION"]},{"type":"string","enum":["ACCOUNT_REINSTATEMENT"]},{"type":"string","enum":["ACCOUNT_CLOSURE"]},{"type":"string","enum":["ORGANIZATION_CLOSURE"]},{"type":"string","enum":["BUSINESS_PROFILE_UPDATE"]},{"type":"string","enum":["WABA_RECONNECT"]},{"type":"string","enum":["APP_CREDENTIAL_ROTATION"]},{"type":"string","enum":["PROVIDER_VERSION_ROLLOUT"]},{"type":"string","enum":["SUBSCRIPTION_RECONCILE"]},{"type":"string","enum":["COEXISTENCE_HISTORY_SYNC"]}]},"state":{"anyOf":[{"type":"string","enum":["PENDING"]},{"type":"string","enum":["QUEUED"]},{"type":"string","enum":["VALIDATING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["WAITING_FOR_APPROVAL"]},{"type":"string","enum":["WAITING_FOR_CUSTOMER"]},{"type":"string","enum":["WAITING_FOR_PROVIDER"]},{"type":"string","enum":["RETRYING"]},{"type":"string","enum":["BLOCKED_DISCONNECTED"]},{"type":"string","enum":["SUCCEEDED"]},{"type":"string","enum":["PARTIALLY_SUCCEEDED"]},{"type":"string","enum":["FAILED"]},{"type":"string","enum":["CANCELED"]}]},"progress":{"additionalProperties":{"type":"number"},"type":"object","properties":{}},"currentStep":{"anyOf":[{"type":"string"},{"type":"null"}]},"steps":{"type":"array","items":{}},"resultUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"retryEligible":{"type":"boolean"},"cancelRequested":{"type":"boolean"},"blocker":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"attempt":{"type":"integer"},"input":{"additionalProperties":true,"type":"object","properties":{}},"createdBy":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"endedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiresAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/test-send":{"post":{"summary":"Send a billed campaign sample to at most 10 contacts","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["contactSids"],"properties":{"contactSids":{"minItems":1,"maxItems":10,"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","type","state","progress","currentStep","steps","resultUrl","error","retryEligible","cancelRequested","blocker","attempt","input","createdBy","livemode","createdAt","updatedAt","startedAt","endedAt","expiresAt"],"properties":{"object":{"type":"string","enum":["operation"]},"sid":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","description":"Operation SID","type":"string"},"type":{"anyOf":[{"type":"string","enum":["ONBOARD_SENDER"]},{"type":"string","enum":["REGISTER"]},{"type":"string","enum":["DEREGISTER"]},{"type":"string","enum":["DISPLAY_NAME"]},{"type":"string","enum":["NUMBER_MIGRATION"]},{"type":"string","enum":["TEMPLATE_SUBMIT"]},{"type":"string","enum":["TEMPLATE_EDIT"]},{"type":"string","enum":["TEMPLATE_DELETE"]},{"type":"string","enum":["TEMPLATE_MIGRATION"]},{"type":"string","enum":["IMPORT"]},{"type":"string","enum":["EXPORT"]},{"type":"string","enum":["CAMPAIGN_DRY_RUN"]},{"type":"string","enum":["CAMPAIGN_TEST_SEND"]},{"type":"string","enum":["BILLING_MODE_SWITCH"]},{"type":"string","enum":["SANDBOX_RESET"]},{"type":"string","enum":["DELETION"]},{"type":"string","enum":["WABA_DISCONNECT"]},{"type":"string","enum":["FLOWS_KEY_UPLOAD"]},{"type":"string","enum":["FLOW_PUBLISH"]},{"type":"string","enum":["FLOW_DEPRECATE"]},{"type":"string","enum":["PRIVACY_REQUEST"]},{"type":"string","enum":["ACCOUNT_SUSPENSION"]},{"type":"string","enum":["ACCOUNT_REINSTATEMENT"]},{"type":"string","enum":["ACCOUNT_CLOSURE"]},{"type":"string","enum":["ORGANIZATION_CLOSURE"]},{"type":"string","enum":["BUSINESS_PROFILE_UPDATE"]},{"type":"string","enum":["WABA_RECONNECT"]},{"type":"string","enum":["APP_CREDENTIAL_ROTATION"]},{"type":"string","enum":["PROVIDER_VERSION_ROLLOUT"]},{"type":"string","enum":["SUBSCRIPTION_RECONCILE"]},{"type":"string","enum":["COEXISTENCE_HISTORY_SYNC"]}]},"state":{"anyOf":[{"type":"string","enum":["PENDING"]},{"type":"string","enum":["QUEUED"]},{"type":"string","enum":["VALIDATING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["WAITING_FOR_APPROVAL"]},{"type":"string","enum":["WAITING_FOR_CUSTOMER"]},{"type":"string","enum":["WAITING_FOR_PROVIDER"]},{"type":"string","enum":["RETRYING"]},{"type":"string","enum":["BLOCKED_DISCONNECTED"]},{"type":"string","enum":["SUCCEEDED"]},{"type":"string","enum":["PARTIALLY_SUCCEEDED"]},{"type":"string","enum":["FAILED"]},{"type":"string","enum":["CANCELED"]}]},"progress":{"additionalProperties":{"type":"number"},"type":"object","properties":{}},"currentStep":{"anyOf":[{"type":"string"},{"type":"null"}]},"steps":{"type":"array","items":{}},"resultUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"retryEligible":{"type":"boolean"},"cancelRequested":{"type":"boolean"},"blocker":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"attempt":{"type":"integer"},"input":{"additionalProperties":true,"type":"object","properties":{}},"createdBy":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"endedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiresAt":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/retry-eligible":{"post":{"summary":"Create a draft campaign for retryable failed recipients","tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"name":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","name","audience","contentSid","variablesMapping","senderSids","senderPoolSid","schedule","pacing","budgetCapMinor","budgetReservedMinor","headerMediaSid","budgetMetaEstimateMinor","frequencyPolicy","currency","transport","requiresApproval","approvalSid","state","stateReason","statistics","livemode","createdAt","updatedAt","startedAt","completedAt"],"properties":{"object":{"type":"string","enum":["campaign"]},"sid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"audience":{"additionalProperties":false,"type":"object","properties":{"contactSids":{"type":"array","items":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"segmentSid":{"type":"string"},"importSid":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"variablesMapping":{"type":"object","additionalProperties":{"type":"string"}},"senderSids":{"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"senderPoolSid":{"anyOf":[{"pattern":"^SP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"schedule":{"additionalProperties":false,"type":"object","required":["startAt","endAt","quietHours","timezoneMode"],"properties":{"startAt":{"type":"string"},"endAt":{"type":"string"},"quietHours":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"timezoneMode":{"anyOf":[{"type":"string","enum":["SENDER"]},{"type":"string","enum":["RECIPIENT"]}]}}},"pacing":{"additionalProperties":false,"type":"object","required":["perSenderPerMinute","perAccountPerMinute"],"properties":{"perSenderPerMinute":{"type":"integer"},"perAccountPerMinute":{"anyOf":[{"type":"integer"},{"type":"null"}]}}},"budgetCapMinor":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budgetReservedMinor":{"type":"integer"},"headerMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"budgetMetaEstimateMinor":{"description":"Estimated Meta charge counted against the budget cap for recipients on numbers Meta bills directly, from the rate card's Meta rate. An estimate: Meta's own invoice is final.","type":"integer"},"frequencyPolicy":{"anyOf":[{"additionalProperties":false,"type":"object","required":["maxMessages","windowHours","scope"],"properties":{"maxMessages":{"type":"integer"},"windowHours":{"type":"integer"},"scope":{"anyOf":[{"type":"string","enum":["ALL"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["MARKETING"]}]}}},{"type":"null"}]},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["cloud_api"]},{"type":"string","enum":["marketing_messages"]}]},"requiresApproval":{"type":"boolean"},"approvalSid":{"anyOf":[{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["DRAFT"]},{"type":"string","enum":["PENDING_APPROVAL"]},{"type":"string","enum":["SCHEDULED"]},{"type":"string","enum":["PLANNING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["COMPLETING"]},{"type":"string","enum":["COMPLETED"]},{"type":"string","enum":["CANCELED"]},{"type":"string","enum":["FAILED"]}]},"stateReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"statistics":{"type":"object","additionalProperties":{"type":"number"}},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/exclusions":{"get":{"summary":"List campaign exclusions","tags":["campaigns"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."}},"/v1/accounts/{AC}/campaigns/{CP}/batches":{"get":{"summary":"List campaign planning batches","tags":["campaigns"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."}},"/v1/accounts/{AC}/campaigns/{CP}/experiment":{"put":{"summary":"Configure deterministic campaign variants and holdout","tags":["campaigns","analytics"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","holdoutBasisPoints","attributionWindowDays","primaryEvent","variants"],"properties":{"enabled":{"type":"boolean"},"holdoutBasisPoints":{"minimum":0,"maximum":5000,"type":"integer"},"attributionWindowDays":{"minimum":1,"maximum":90,"type":"integer"},"primaryEvent":{"anyOf":[{"type":"string","enum":["click"]},{"type":"string","enum":["conversion"]}]},"variants":{"maxItems":10,"type":"array","items":{"additionalProperties":false,"type":"object","required":["key","contentSid","allocationBasisPoints"],"properties":{"key":{"pattern":"^[a-zA-Z0-9_-]{1,40}$","type":"string"},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"allocationBasisPoints":{"minimum":1,"maximum":10000,"type":"integer"},"utmParameters":{"maxProperties":10,"type":"object","additionalProperties":{"maxLength":256,"type":"string"}}}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."},"get":{"summary":"Read campaign experiment, holdout and attribution configuration","tags":["campaigns","analytics"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."}},"/v1/accounts/{AC}/campaigns/{CP}/attribution-events":{"post":{"summary":"Record an idempotent campaign click or conversion","tags":["campaigns","analytics"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["externalEventId","eventType","occurredAt"],"properties":{"externalEventId":{"minLength":1,"maxLength":200,"type":"string"},"eventType":{"anyOf":[{"type":"string","enum":["click"]},{"type":"string","enum":["conversion"]}]},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"messageSid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"occurredAt":{"format":"date-time","type":"string"},"valueMinor":{"minimum":0,"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"properties":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:write"],"description":"Required scope: `campaigns:write`."}},"/v1/accounts/{AC}/campaigns/{CP}/experiment-report":{"get":{"summary":"Report campaign outcomes and cost by variant with honest denominators","tags":["campaigns","analytics"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["campaigns:read"],"description":"Required scope: `campaigns:read`."}},"/v1/accounts/{AC}/imports":{"get":{"summary":"List bulk imports","tags":["imports"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."},"post":{"summary":"Upload a bulk import","tags":["imports"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"required":["kind","file"],"properties":{"kind":{"type":"string","enum":["CONTACTS","CONSENTS","SUPPRESSIONS","AUDIENCE"]},"file":{"type":"string","format":"binary"},"format":{"type":"string","enum":["CSV","JSON","XLSX"]},"defaultCountry":{"type":"string","pattern":"^[A-Z]{2}$"}}}}}},"x-required-scope":["contacts:write"],"description":"Required scope: `contacts:write`."}},"/v1/accounts/{AC}/exports":{"get":{"summary":"List private exports","tags":["exports"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["exports:create","billing:write","audit:read"],"description":"Required scope: any one of `exports:create`, `billing:write`, `audit:read`."},"post":{"summary":"Create a private data export","tags":["exports"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["kind","stepUpToken"],"properties":{"kind":{"anyOf":[{"type":"string","enum":["messages"]},{"type":"string","enum":["billing"]},{"type":"string","enum":["audit"]},{"type":"string","enum":["analytics"]},{"type":"string","enum":["contacts"]}]},"filters":{"additionalProperties":false,"type":"object","properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"},"status":{"maxLength":64,"type":"string"},"state":{"maxLength":64,"type":"string"},"action":{"maxLength":128,"type":"string"},"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"category":{"maxLength":64,"type":"string"},"campaignSid":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"actorRef":{"minLength":1,"maxLength":256,"type":"string"},"resourceRef":{"minLength":1,"maxLength":256,"type":"string"}}},"format":{"anyOf":[{"type":"string","enum":["csv"]},{"type":"string","enum":["json"]}]},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["object","sid","type","state","progress","currentStep","steps","resultUrl","error","retryEligible","cancelRequested","blocker","attempt","input","createdBy","livemode","createdAt","updatedAt","startedAt","endedAt","expiresAt","exportSid"],"properties":{"object":{"type":"string","enum":["operation"]},"sid":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","description":"Operation SID","type":"string"},"type":{"anyOf":[{"type":"string","enum":["ONBOARD_SENDER"]},{"type":"string","enum":["REGISTER"]},{"type":"string","enum":["DEREGISTER"]},{"type":"string","enum":["DISPLAY_NAME"]},{"type":"string","enum":["NUMBER_MIGRATION"]},{"type":"string","enum":["TEMPLATE_SUBMIT"]},{"type":"string","enum":["TEMPLATE_EDIT"]},{"type":"string","enum":["TEMPLATE_DELETE"]},{"type":"string","enum":["TEMPLATE_MIGRATION"]},{"type":"string","enum":["IMPORT"]},{"type":"string","enum":["EXPORT"]},{"type":"string","enum":["CAMPAIGN_DRY_RUN"]},{"type":"string","enum":["CAMPAIGN_TEST_SEND"]},{"type":"string","enum":["BILLING_MODE_SWITCH"]},{"type":"string","enum":["SANDBOX_RESET"]},{"type":"string","enum":["DELETION"]},{"type":"string","enum":["WABA_DISCONNECT"]},{"type":"string","enum":["FLOWS_KEY_UPLOAD"]},{"type":"string","enum":["FLOW_PUBLISH"]},{"type":"string","enum":["FLOW_DEPRECATE"]},{"type":"string","enum":["PRIVACY_REQUEST"]},{"type":"string","enum":["ACCOUNT_SUSPENSION"]},{"type":"string","enum":["ACCOUNT_REINSTATEMENT"]},{"type":"string","enum":["ACCOUNT_CLOSURE"]},{"type":"string","enum":["ORGANIZATION_CLOSURE"]},{"type":"string","enum":["BUSINESS_PROFILE_UPDATE"]},{"type":"string","enum":["WABA_RECONNECT"]},{"type":"string","enum":["APP_CREDENTIAL_ROTATION"]},{"type":"string","enum":["PROVIDER_VERSION_ROLLOUT"]},{"type":"string","enum":["SUBSCRIPTION_RECONCILE"]},{"type":"string","enum":["COEXISTENCE_HISTORY_SYNC"]}]},"state":{"anyOf":[{"type":"string","enum":["PENDING"]},{"type":"string","enum":["QUEUED"]},{"type":"string","enum":["VALIDATING"]},{"type":"string","enum":["RUNNING"]},{"type":"string","enum":["PAUSED"]},{"type":"string","enum":["WAITING_FOR_APPROVAL"]},{"type":"string","enum":["WAITING_FOR_CUSTOMER"]},{"type":"string","enum":["WAITING_FOR_PROVIDER"]},{"type":"string","enum":["RETRYING"]},{"type":"string","enum":["BLOCKED_DISCONNECTED"]},{"type":"string","enum":["SUCCEEDED"]},{"type":"string","enum":["PARTIALLY_SUCCEEDED"]},{"type":"string","enum":["FAILED"]},{"type":"string","enum":["CANCELED"]}]},"progress":{"additionalProperties":{"type":"number"},"type":"object","properties":{}},"currentStep":{"anyOf":[{"type":"string"},{"type":"null"}]},"steps":{"type":"array","items":{}},"resultUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"retryEligible":{"type":"boolean"},"cancelRequested":{"type":"boolean"},"blocker":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"null"}]},"attempt":{"type":"integer"},"input":{"additionalProperties":true,"type":"object","properties":{}},"createdBy":{"type":"string"},"livemode":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"endedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiresAt":{"type":"string"},"exportSid":{"pattern":"^EX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["exports:create","billing:write"],"description":"Required scope: any one of `exports:create`, `billing:write`."}},"/v1/accounts/{AC}/imports/{IM}":{"get":{"summary":"Fetch an import","tags":["imports"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IM","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."}},"/v1/accounts/{AC}/imports/{IM}/rejections":{"get":{"summary":"List rejected import rows with structured reasons","tags":["imports"],"parameters":[{"schema":{"minLength":1,"maxLength":200,"type":"string"},"in":"query","name":"reason","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IM","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["operations:read"],"description":"Required scope: `operations:read`."}},"/v1/accounts/{AC}/exports/{EX}":{"get":{"summary":"Fetch an export and short-lived result URL","tags":["exports"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^EX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"EX","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["exports:create","billing:write","audit:read"],"description":"Required scope: any one of `exports:create`, `billing:write`, `audit:read`."}},"/v1/accounts/{AC}/security/keys/rotate":{"post":{"summary":"Rotate the account data encryption key (new Transit key version)","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","approvalSid","reason"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/security/keys":{"get":{"summary":"Show the account data encryption key version and its last rotation","tags":["accounts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["audit:read"],"description":"Required scope: `audit:read`."}},"/v1/accounts/{AC}/usage":{"get":{"summary":"Get usage grouped by account dimension","tags":["usage"],"parameters":[{"schema":{"anyOf":[{"type":"string","enum":["day"]},{"type":"string","enum":["sender"]},{"type":"string","enum":["category"]},{"type":"string","enum":["subaccount"]}]},"in":"query","name":"groupBy","required":false},{"schema":{"format":"date","type":"string"},"in":"query","name":"from","required":false},{"schema":{"format":"date","type":"string"},"in":"query","name":"to","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["usage:read"],"description":"Required scope: `usage:read`."}},"/v1/accounts/{AC}/usage/limits":{"get":{"summary":"Get plan and Meta limits with utilisation","tags":["usage"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["usage:read"],"description":"Required scope: `usage:read`."}},"/v1/accounts/{AC}/usage/api":{"get":{"summary":"Get API request usage by route family","tags":["usage"],"description":"Per-minute aggregate (§39). Ship Messages keeps no per-request log, so this reports request counts, rate-limited counts and latency by route family and status class.\n\nRequired scope: `usage:read`.","parameters":[{"schema":{"minimum":1,"maximum":168,"type":"integer"},"in":"query","name":"hours","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["usage:read"]}},"/v1/accounts/{AC}/usage/api-consumption":{"get":{"summary":"Get API consumption by credential, endpoint and rate-limit scope (DEV-013)","tags":["usage"],"description":"§16.8 developer view. Aggregated from the retained request facts (§16.5, 30 days), so consumption is attributable to the API key that spent it, to the route template it was spent on, and a 429 to the RateLimit-Policy scope that refused it.\n\nRequired scope: `usage:read`.","parameters":[{"schema":{"minimum":1,"maximum":168,"type":"integer"},"in":"query","name":"hours","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["usage:read"]}},"/v1/accounts/{AC}/lookup/{phone}":{"get":{"summary":"Normalise and classify a phone number","tags":["lookup"],"description":"This endpoint does not test or return WhatsApp reachability.\n\nRequired scope: `contacts:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"minLength":4,"maxLength":64,"type":"string"},"in":"path","name":"phone","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"]}},"/v1/accounts/{AC}/sandbox/reset":{"post":{"summary":"Reset sandbox data","tags":["sandbox"],"requestBody":{"required":true,"content":{"application/json":{"schema":{}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["sandbox:reset"],"description":"Required scope: `sandbox:reset`."}},"/v1/accounts/{AC}/sandbox/scenarios":{"get":{"summary":"List failure-simulator scenarios and the selections in force","tags":["sandbox"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["sandbox:reset"],"description":"Required scope: `sandbox:reset`."},"post":{"summary":"Choose the outcome of the next N sandbox sends","tags":["sandbox"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["scenario","sends"],"properties":{"scenario":{"minLength":1,"maxLength":64,"type":"string"},"sends":{"minimum":1,"maximum":100,"type":"integer"},"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["sandbox:reset"],"description":"Required scope: `sandbox:reset`."},"delete":{"summary":"Cancel the scenario in force for a sandbox sender","tags":["sandbox"],"parameters":[{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"senderSid","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["sandbox:reset"],"description":"Required scope: `sandbox:reset`."}},"/v1/accounts/{AC}/sandbox/fixtures":{"get":{"summary":"List canonical sandbox simulator fixtures","tags":["sandbox"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["sandbox:reset"],"description":"Required scope: `sandbox:reset`."}},"/v1/accounts/{AC}/billing/top-ups":{"post":{"summary":"Start provider-hosted wallet funding","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["amountMinor","currency","idempotencyKey","stepUpToken"],"properties":{"amountMinor":{"pattern":"^[1-9][0-9]{0,7}$","type":"string"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"idempotencyKey":{"minLength":8,"maxLength":255,"type":"string"},"stepUpToken":{"minLength":16,"maxLength":4096,"type":"string"},"saveCardForInvoices":{"type":"boolean"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/message-quote":{"post":{"summary":"Quote one message from the effective immutable pricing fact","tags":["billing","messages"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["senderSid","identifierType","recipient","category"],"properties":{"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"identifierType":{"anyOf":[{"type":"string","enum":["PHONE_E164"]},{"type":"string","enum":["BSUID"]},{"type":"string","enum":["USERNAME"]}]},"recipient":{"minLength":1,"maxLength":512,"type":"string"},"category":{"pattern":"^[A-Z][A-Z0-9_]{0,63}$","type":"string"},"transport":{"anyOf":[{"type":"string","enum":["CLOUD_API"]},{"type":"string","enum":["MARKETING_MESSAGES"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/wallets":{"get":{"summary":"List billing wallets and ledger-derived available funds","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^[A-Z]{3}$","type":"string"},"in":"query","name":"currency","required":false},{"schema":{"anyOf":[{"type":"string","enum":["prepaid"]},{"type":"string","enum":["postpaid"]},{"type":"string","enum":["credit_line"]},{"type":"string","enum":["invoice"]},{"type":"string","enum":["hybrid"]}]},"in":"query","name":"commercialMode","required":false},{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"query","name":"billingStatus","required":false},{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"query","name":"dunningState","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","subaccountId","subaccountSid","subaccountName","currency","scale","commercialMode","billingStatus","dunningState","suspensionReason","creditLimitMinor","availableMinor","pendingRefundMinor","reservedMinor","nextInvoiceAt"],"properties":{"id":{"format":"uuid","type":"string"},"subaccountId":{"anyOf":[{"type":"string"},{"type":"null"}]},"subaccountSid":{"anyOf":[{"type":"string"},{"type":"null"}]},"subaccountName":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"scale":{"type":"integer"},"commercialMode":{"type":"string"},"billingStatus":{"type":"string"},"dunningState":{"type":"string"},"suspensionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditLimitMinor":{"pattern":"^-?[0-9]+$","type":"string"},"availableMinor":{"pattern":"^-?[0-9]+$","type":"string"},"pendingRefundMinor":{"pattern":"^-?[0-9]+$","type":"string"},"reservedMinor":{"pattern":"^-?[0-9]+$","type":"string"},"nextInvoiceAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/charges":{"get":{"summary":"List settled charges with their message, sender, market and evidence (§17.2)","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":false},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"senderSid","required":false},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"campaignSid","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/payments":{"get":{"summary":"List payment lifecycle state without exposing payment credentials","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"query","name":"state","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/invoices":{"get":{"summary":"List durable invoices without exposing payment-provider credentials","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"anyOf":[{"type":"string","enum":["draft"]},{"type":"string","enum":["pending_provider"]},{"type":"string","enum":["open"]},{"type":"string","enum":["past_due"]},{"type":"string","enum":["paid"]},{"type":"string","enum":["void"]},{"type":"string","enum":["uncollectible"]},{"type":"string","enum":["failed"]}]},"in":"query","name":"state","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/automation":{"put":{"summary":"Configure tax-gated invoicing periods and durable collection retries","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["currency","nextPeriodStart","nextPeriodEnd"],"properties":{"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"nextPeriodStart":{"format":"date-time","type":"string"},"nextPeriodEnd":{"format":"date-time","type":"string"},"collection":{"additionalProperties":false,"type":"object","required":["paymentIntentId","retryDelaysHours","stepUpToken"],"properties":{"paymentIntentId":{"format":"uuid","type":"string"},"retryDelaysHours":{"minItems":1,"maxItems":10,"type":"array","items":{"minimum":0,"maximum":8760,"type":"integer"}},"stepUpToken":{"minLength":16,"maxLength":4096,"type":"string"}}},"providerStatement":{"additionalProperties":false,"type":"object","required":["provider","wabaSid","nextPeriodStart","nextPeriodEnd"],"properties":{"provider":{"minLength":1,"maxLength":128,"type":"string"},"wabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"nextPeriodStart":{"format":"date-time","type":"string"},"nextPeriodEnd":{"format":"date-time","type":"string"}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/tax-profile":{"put":{"summary":"Set the tax profile an account's invoices are calculated under (staff only)","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["currency","taxProvider","taxJurisdiction","taxCode","invoiceProvider","reason","stepUpToken"],"properties":{"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"taxProvider":{"minLength":1,"maxLength":128,"type":"string"},"taxJurisdiction":{"minLength":1,"maxLength":128,"type":"string"},"taxCode":{"minLength":1,"maxLength":128,"type":"string"},"invoiceProvider":{"minLength":1,"maxLength":128,"type":"string"},"reason":{"minLength":1,"maxLength":500,"type":"string"},"stepUpToken":{"minLength":16,"maxLength":4096,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/rate-card":{"get":{"summary":"What this account is charged per message, in force today (§33)","tags":["billing"],"description":"The same effective-dated pricing facts the quote and the settlement read, filtered to what the account holder is actually charged. The admin listing beside this one needs platform:configure, which no customer holds, so until now a business could be charged a rate it had no way to read. Provider cost and margin are deliberately absent: what the platform pays Meta is not the customer's charge and showing it would invite the two to be confused.\n\nRequired scope: `billing:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"]}},"/v1/accounts/{AC}/billing/invoices/{IN}":{"get":{"summary":"Fetch an invoice and its immutable line references","tags":["billing"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IN[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IN","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/invoices/{IN}/resubmit":{"post":{"summary":"Re-queue a terminally failed invoice submission","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IN[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IN","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/invoices/{IN}/void":{"post":{"summary":"Void an invoice issued in error (§116.5)","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","idempotencyKey","evidence"],"properties":{"reason":{"minLength":1,"maxLength":500,"type":"string"},"idempotencyKey":{"minLength":8,"maxLength":255,"type":"string"},"evidence":{"minProperties":1,"type":"object","additionalProperties":{}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IN[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IN","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/invoices/{IN}/write-off":{"post":{"summary":"Write a past-due invoice off as uncollectible (§116.5)","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","idempotencyKey","evidence"],"properties":{"reason":{"minLength":1,"maxLength":500,"type":"string"},"idempotencyKey":{"minLength":8,"maxLength":255,"type":"string"},"evidence":{"minProperties":1,"type":"object","additionalProperties":{}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IN[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IN","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/invoices/{IN}/credit-notes":{"post":{"summary":"Issue a ledger-backed credit note without rewriting invoice history","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["amountMinor","taxMinor","currency","scale","reason","idempotencyKey","evidence"],"properties":{"amountMinor":{"pattern":"^[1-9][0-9]*$","type":"string"},"taxMinor":{"pattern":"^[0-9]+$","type":"string"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"type":"integer"},"reason":{"minLength":1,"maxLength":500,"type":"string"},"idempotencyKey":{"minLength":8,"maxLength":255,"type":"string"},"evidence":{"minProperties":1,"type":"object","additionalProperties":{}},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^IN[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IN","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/refunds":{"post":{"summary":"Issue a provider refund against a captured payment","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","idempotencyKey","stepUpToken","approvalSid"],"properties":{"invoiceSid":{"pattern":"^IN[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"paymentIntentId":{"format":"uuid","type":"string"},"amountMinor":{"pattern":"^[1-9][0-9]*$","type":"string"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"scale":{"minimum":0,"maximum":9,"type":"integer"},"reason":{"anyOf":[{"type":"string","enum":["duplicate"]},{"type":"string","enum":["fraudulent"]},{"type":"string","enum":["requested_by_customer"]}]},"idempotencyKey":{"minLength":8,"maxLength":255,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/reconciliation-cases":{"get":{"summary":"List reconciliation discrepancies with their statement evidence","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"anyOf":[{"type":"string","enum":["open"]},{"type":"string","enum":["investigating"]},{"type":"string","enum":["resolved"]},{"type":"string","enum":["rejected"]}]},"in":"query","name":"state","required":false},{"schema":{"anyOf":[{"type":"string","enum":["amount_mismatch"]},{"type":"string","enum":["missing_platform_event"]},{"type":"string","enum":["unexpected_provider_charge"]},{"type":"string","enum":["missing_provider_status"]}]},"in":"query","name":"outcome","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/reconciliation-cases/{CS}":{"get":{"summary":"Fetch one reconciliation discrepancy and its evidence","tags":["billing"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/reconciliation-cases/{CS}/resolve":{"post":{"summary":"Resolve a reconciliation case with append-only operator evidence","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["resolution","reason","evidence"],"properties":{"resolution":{"anyOf":[{"type":"string","enum":["resolved"]},{"type":"string","enum":["rejected"]}]},"reason":{"minLength":1,"maxLength":500,"type":"string"},"evidence":{"minProperties":1,"type":"object","additionalProperties":{}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/pricing-remediation/{CS}":{"post":{"summary":"Submit signed provider pricing evidence and reprocess a pending settlement","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","signature","pricing"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"signature":{"pattern":"^v1=[0-9a-f]{64}$","type":"string"},"pricing":{"additionalProperties":false,"type":"object","required":["category","pricingType","market","transport","customerCurrency","billable","pricingModel","providerEvidence"],"properties":{"category":{"minLength":1,"maxLength":64,"type":"string"},"pricingType":{"anyOf":[{"type":"string","enum":["REGULAR"]},{"type":"string","enum":["FREE_CUSTOMER_SERVICE"]},{"type":"string","enum":["FREE_ENTRY_POINT"]}]},"market":{"minLength":1,"maxLength":16,"type":"string"},"transport":{"minLength":1,"maxLength":64,"type":"string"},"customerCurrency":{"pattern":"^[A-Z]{3}$","type":"string"},"billable":{"type":"boolean"},"pricingModel":{"minLength":1,"maxLength":128,"type":"string"},"providerEvidence":{"minProperties":1,"type":"object","additionalProperties":{}}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/wabas/{WB}/billing-mode":{"get":{"summary":"Fetch the effective WABA billing mode and migration state","tags":["billing","wabas"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/wabas/{WB}/billing-mode-switch":{"post":{"summary":"Start a safely gated migration to partner billing","tags":["billing","wabas"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/wabas/{WB}/billing-mode-switch/accept":{"post":{"summary":"Accept partner-billing terms with a single-use MFA step-up grant","tags":["billing","wabas"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["termsVersion","stepUpEvidence"],"properties":{"termsVersion":{"minLength":1,"maxLength":128,"type":"string"},"stepUpEvidence":{"minLength":16,"maxLength":4096,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing_mode:accept"],"description":"Required scope: `billing_mode:accept`."}},"/v1/accounts/{AC}/wabas/{WB}/billing-mode-switch/revert":{"post":{"summary":"Revert partner billing only after durable Meta credit-allocation revocation","tags":["billing","wabas"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["idempotencyKey","reason"],"properties":{"idempotencyKey":{"minLength":8,"maxLength":255,"type":"string"},"reason":{"type":"string","enum":["customer_disconnected"]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/billing/receipts":{"get":{"summary":"List the receipts issued for captured wallet top-ups (§116.5)","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/receipts/{RC}":{"get":{"summary":"Fetch a top-up receipt with its immutable document","tags":["billing"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^RC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"RC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/statements":{"get":{"summary":"List monthly statements for prepaid wallets (§116)","tags":["billing"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/statements/{ST}":{"get":{"summary":"Fetch a monthly statement with its immutable document","tags":["billing"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^ST[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"ST","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/low-balance-alerts":{"get":{"summary":"Read the low-balance alert of each live wallet","tags":["billing"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:read"],"description":"Required scope: `billing:read`."}},"/v1/accounts/{AC}/billing/low-balance-alerts/{currency}":{"put":{"summary":"Set the balance below which the wallet warns its owners (§116)","tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["threshold"],"properties":{"threshold":{"anyOf":[{"pattern":"^[0-9][0-9,]*(\\.[0-9]+)?$","maxLength":24,"description":"Warn when the available balance falls below this amount, in the wallet currency's own units (\"20\" yen, \"15.00\" pounds). \"0\" turns the alert off.","type":"string"},{"description":"Return to the platform default threshold.","type":"null"}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^[A-Z]{3}$","type":"string"},"in":"path","name":"currency","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["billing:write"],"description":"Required scope: `billing:write`."}},"/v1/accounts/{AC}/calls":{"get":{"summary":"List observed call lifecycles","tags":["calls"],"description":"Read-only CALL_EVENT projection. Outbound calling is unavailable until a verified provider capability is enabled.\n\nRequired scope: `calls:read`.","parameters":[{"schema":{"maxLength":32,"type":"string"},"in":"query","name":"state","required":false},{"schema":{"anyOf":[{"type":"string","enum":["INBOUND"]},{"type":"string","enum":["OUTBOUND"]}]},"in":"query","name":"direction","required":false},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"senderSid","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","senderSid","contactSid","direction","state","providerCallId","lastEventAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["call"]},"sid":{"pattern":"^CL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"senderSid":{"anyOf":[{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"contactSid":{"anyOf":[{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"direction":{"anyOf":[{"type":"string","enum":["INBOUND"]},{"type":"string","enum":["OUTBOUND"]},{"type":"null"}]},"state":{"type":"string"},"providerCallId":{"type":"string"},"lastEventAt":{"format":"date-time","type":"string"},"livemode":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"events":{"type":"array","items":{"type":"object","required":["sid","type","state","occurredAt","transitionApplied","providerEventId","evidenceSha256"],"properties":{"sid":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"type":{"type":"string"},"state":{"type":"string"},"occurredAt":{"format":"date-time","type":"string"},"transitionApplied":{"type":"boolean"},"providerEventId":{"anyOf":[{"type":"string"},{"type":"null"}]},"evidenceSha256":{"pattern":"^[a-f0-9]{64}$","type":"string"}}}}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["calls:read"]}},"/v1/accounts/{AC}/calls/{CL}":{"get":{"summary":"Fetch an observed call lifecycle","tags":["calls"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CL","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","sid","senderSid","contactSid","direction","state","providerCallId","lastEventAt","livemode","createdAt","updatedAt"],"properties":{"object":{"type":"string","enum":["call"]},"sid":{"pattern":"^CL[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"senderSid":{"anyOf":[{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"contactSid":{"anyOf":[{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"direction":{"anyOf":[{"type":"string","enum":["INBOUND"]},{"type":"string","enum":["OUTBOUND"]},{"type":"null"}]},"state":{"type":"string"},"providerCallId":{"type":"string"},"lastEventAt":{"format":"date-time","type":"string"},"livemode":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"events":{"type":"array","items":{"type":"object","required":["sid","type","state","occurredAt","transitionApplied","providerEventId","evidenceSha256"],"properties":{"sid":{"pattern":"^EV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"type":{"type":"string"},"state":{"type":"string"},"occurredAt":{"format":"date-time","type":"string"},"transitionApplied":{"type":"boolean"},"providerEventId":{"anyOf":[{"type":"string"},{"type":"null"}]},"evidenceSha256":{"pattern":"^[a-f0-9]{64}$","type":"string"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["calls:read"],"description":"Required scope: `calls:read`."}},"/v1/accounts/{AC}/risk/decisions":{"get":{"summary":"List customer-visible risk decisions","tags":["risk"],"parameters":[{"schema":{"maxLength":32,"type":"string"},"in":"query","name":"verdict","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","sid","scopeType","scopeRef","verdict","reasonCodes","customerReason","policyVersion","throttleUntil","expiresAt","appeal","createdAt"],"properties":{"object":{"type":"string","enum":["risk_decision"]},"sid":{"pattern":"^RD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"scopeType":{"type":"string"},"scopeRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"verdict":{"type":"string"},"reasonCodes":{"type":"array","items":{"type":"string"}},"customerReason":{"type":"string"},"policyVersion":{"type":"string"},"throttleUntil":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"expiresAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"appeal":{"anyOf":[{"type":"object","required":["supportCaseSid","state"],"properties":{"supportCaseSid":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"state":{"type":"string"}}},{"type":"null"}]},"createdAt":{"format":"date-time","type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["risk:read"],"description":"Required scope: `risk:read`."}},"/v1/accounts/{AC}/risk/profile":{"get":{"summary":"Read the account's use-case standing","tags":["risk"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","environment","trustLevel","useCaseStatus","useCaseCode","reviewedAt","guardrail"],"properties":{"object":{"type":"string","enum":["risk_profile"]},"environment":{"anyOf":[{"type":"string","enum":["live"]},{"type":"string","enum":["sandbox"]}]},"trustLevel":{"type":"string"},"useCaseStatus":{"type":"string"},"useCaseCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reviewedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"guardrail":{"type":"object","required":["path","policyVersion","signals","stage","stageReason","warmup"],"properties":{"path":{"anyOf":[{"type":"string","enum":["hosted"]},{"type":"string","enum":["self_serve"]}]},"policyVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"signals":{"type":"array","items":{"type":"object","required":["type","label","value","kind","lowerIsWorse","warn","throttle","severe","band","note"],"properties":{"type":{"type":"string"},"label":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["rate"]},{"type":"string","enum":["count"]}]},"lowerIsWorse":{"type":"boolean"},"warn":{"anyOf":[{"type":"number"},{"type":"null"}]},"throttle":{"anyOf":[{"type":"number"},{"type":"null"}]},"severe":{"anyOf":[{"type":"number"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","enum":["clear"]},{"type":"string","enum":["warn"]},{"type":"string","enum":["throttle"]},{"type":"string","enum":["severe"]},{"type":"string","enum":["unknown"]}]},"note":{"type":"string"}}}},"stage":{"anyOf":[{"type":"string","enum":["clear"]},{"type":"string","enum":["warned"]},{"type":"string","enum":["throttled"]},{"type":"string","enum":["bulk_paused"]},{"type":"string","enum":["suspended"]}]},"stageReason":{"type":"string"},"warmup":{"type":"array","items":{"type":"object","required":["senderSid","displayPhoneNumber","hosted","dayOfLife","dailyCap","usedToday","remainingToday","rampEndsDay","recoveryWarmupUntil"],"properties":{"senderSid":{"type":"string"},"displayPhoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"hosted":{"type":"boolean"},"dayOfLife":{"type":"integer"},"dailyCap":{"anyOf":[{"type":"integer"},{"type":"null"}]},"usedToday":{"type":"integer"},"remainingToday":{"anyOf":[{"type":"integer"},{"type":"null"}]},"rampEndsDay":{"anyOf":[{"type":"integer"},{"type":"null"}]},"recoveryWarmupUntil":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["risk:read"],"description":"Required scope: `risk:read`."}},"/v1/accounts/{AC}/risk/decisions/{RD}/appeal":{"post":{"summary":"Appeal a risk decision","tags":["risk"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^RD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"RD","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","decisionSid","supportCaseSid","state","createdAt"],"properties":{"object":{"type":"string","enum":["risk_appeal"]},"decisionSid":{"pattern":"^RD[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"supportCaseSid":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"state":{"type":"string"},"createdAt":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["risk:appeal"],"description":"Required scope: `risk:appeal`."}},"/v1/accounts/{AC}/analytics/messages":{"get":{"summary":"Query message analytics","tags":["analytics"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"minimum":1,"maximum":10000,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["bucket","accepted","sent","delivered","read","failed","costMinor","currency"],"properties":{"bucket":{"format":"date-time","type":"string"},"accepted":{"type":"number"},"sent":{"type":"number"},"delivered":{"type":"number"},"read":{"type":"number"},"failed":{"type":"number"},"costMinor":{"type":"integer"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/analytics/errors":{"get":{"summary":"Query top errors","tags":["analytics"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"minimum":1,"maximum":10000,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["errorClass","errorType","providerErrorCode","count"],"properties":{"errorClass":{"type":"string"},"errorType":{"type":"string"},"providerErrorCode":{"type":"integer"},"count":{"type":"number"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/analytics/webhook-reliability":{"get":{"summary":"Query webhook delivery reliability","tags":["analytics"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"minimum":1,"maximum":10000,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["bucket","endpointId","attempted","succeeded","failed","p95LatencyMs"],"properties":{"bucket":{"format":"date-time","type":"string"},"endpointId":{"type":"string"},"attempted":{"type":"number"},"succeeded":{"type":"number"},"failed":{"type":"number"},"p95LatencyMs":{"type":"number"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/analytics/countries":{"get":{"summary":"Query traffic by calling code","tags":["analytics"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"minimum":1,"maximum":10000,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["countryCallingCode","sent","delivered","read","failed"],"properties":{"countryCallingCode":{"type":"string"},"sent":{"type":"number"},"delivered":{"type":"number"},"read":{"type":"number"},"failed":{"type":"number"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/analytics/campaigns":{"get":{"summary":"Query campaign results","tags":["analytics"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"minimum":1,"maximum":10000,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["campaignId","campaignSid","targeted","excluded","accepted","delivered","read","failed"],"properties":{"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignSid":{"type":"string"},"targeted":{"type":"number"},"excluded":{"type":"number"},"accepted":{"type":"number"},"delivered":{"type":"number"},"read":{"type":"number"},"failed":{"type":"number"}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/analytics/replies":{"get":{"summary":"Query persisted reply attribution and response time","tags":["analytics"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["category","outbound","replies","replyRate","averageResponseMs","p95ResponseMs"],"properties":{"category":{"type":"string"},"outbound":{"type":"integer"},"replies":{"type":"integer"},"replyRate":{"type":"number"},"averageResponseMs":{"anyOf":[{"type":"integer"},{"type":"null"}]},"p95ResponseMs":{"anyOf":[{"type":"integer"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/analytics/conversation-performance":{"get":{"summary":"Query append-only agent or queue performance facts","tags":["analytics","conversations"],"parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":true},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":true},{"schema":{"anyOf":[{"type":"string","enum":["agent"]},{"type":"string","enum":["queue"]}]},"in":"query","name":"dimension","required":true},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["source","dataAsOf","freshnessNote","points"],"properties":{"source":{"anyOf":[{"type":"string","enum":["CLICKHOUSE"]},{"type":"string","enum":["PG_ROLLUP"]}]},"dataAsOf":{"format":"date-time","type":"string"},"freshnessNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","required":["dimension","key","label","opened","assigned","resolved","active","firstResponseMet","firstResponseBreached","averageWaitSeconds","averageHandlingSeconds","averageResolutionSeconds","availableTransitions","busyTransitions","availableSeconds","busySeconds","resolvedWithinSla","resolvedBreached","capacity","occupancy","utilization","csatResponses","csatAverage"],"properties":{"dimension":{"anyOf":[{"type":"string","enum":["agent"]},{"type":"string","enum":["queue"]}]},"key":{"type":"string"},"label":{"type":"string"},"opened":{"type":"integer"},"assigned":{"type":"integer"},"resolved":{"type":"integer"},"active":{"type":"integer"},"firstResponseMet":{"type":"integer"},"firstResponseBreached":{"type":"integer"},"averageWaitSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"averageHandlingSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"averageResolutionSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"availableTransitions":{"type":"integer"},"busyTransitions":{"type":"integer"},"availableSeconds":{"type":"integer"},"busySeconds":{"type":"integer"},"resolvedWithinSla":{"type":"integer"},"resolvedBreached":{"type":"integer"},"capacity":{"anyOf":[{"type":"integer"},{"type":"null"}]},"occupancy":{"anyOf":[{"type":"number"},{"type":"null"}]},"utilization":{"anyOf":[{"type":"number"},{"type":"null"}]},"csatResponses":{"type":"integer"},"csatAverage":{"anyOf":[{"type":"number"},{"type":"null"}]}}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/search":{"get":{"summary":"Search operational resources","tags":["search"],"parameters":[{"schema":{"minLength":2,"maxLength":128,"type":"string"},"in":"query","name":"q","required":true},{"schema":{"anyOf":[{"type":"string","enum":["MESSAGE"]},{"type":"string","enum":["SENDER"]},{"type":"string","enum":["WABA"]},{"type":"string","enum":["TEMPLATE"]},{"type":"string","enum":["CONTACT"]},{"type":"string","enum":["ACCOUNT"]},{"type":"string","enum":["CAMPAIGN"]},{"type":"string","enum":["EVENT"]},{"type":"string","enum":["WEBHOOK_DELIVERY"]},{"type":"string","enum":["OPERATION"]},{"type":"string","enum":["FINANCIAL_TRANSACTION"]},{"type":"string","enum":["SUPPORT_CASE"]}]},"in":"query","name":"type","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","resourceType","resourceRef","displayRef","displayName","parentRef","state","sourceOccurredAt","indexedAt"],"properties":{"object":{"type":"string","enum":["search_result"]},"resourceType":{"type":"string"},"resourceRef":{"type":"string"},"displayRef":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceOccurredAt":{"format":"date-time","type":"string"},"indexedAt":{"format":"date-time","type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["search:read"],"description":"Required scope: `search:read`."}},"/v1/accounts/{AC}/bot-applications":{"get":{"summary":"List customer-controlled bot applications","tags":["conversations","applications"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"post":{"summary":"Create a customer-controlled bot application","tags":["conversations","applications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","principalRef","webhookEndpointSid","fallbackInboxSid"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"principalRef":{"minLength":1,"maxLength":128,"type":"string"},"webhookEndpointSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"fallbackInboxSid":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"timeoutSeconds":{"minimum":5,"maximum":3600,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/bot-applications/{BA}":{"patch":{"summary":"Update a customer-controlled bot application","tags":["conversations","applications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"principalRef":{"minLength":1,"maxLength":128,"type":"string"},"webhookEndpointSid":{"pattern":"^WH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"fallbackInboxSid":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"timeoutSeconds":{"minimum":5,"maximum":3600,"type":"integer"}},"minProperties":1}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^BA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"BA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."},"delete":{"summary":"Disable a bot application when it has no active handoff","tags":["conversations","applications"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^BA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"BA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/conversations/{CO}/bot-handoffs/{BH}/respond":{"post":{"summary":"Acknowledge, activate, complete, or reject a bot handoff","tags":["conversations","applications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["outcome"],"properties":{"outcome":{"anyOf":[{"type":"string","enum":["ACCEPT"]},{"type":"string","enum":["ACTIVE"]},{"type":"string","enum":["COMPLETE"]},{"type":"string","enum":["FAIL"]}]},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^BH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"BH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"description":"Required scope: `conversations:write`."}},"/v1/accounts/{AC}/conversations/{CO}/bot-handoffs/{BH}/takeover":{"post":{"summary":"Take an active bot handoff back to its human fallback inbox","tags":["conversations","applications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^BH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"BH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:assign","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/bot-handoffs/{BH}/retry":{"post":{"summary":"Retry a failed or timed-out bot handoff","tags":["conversations","applications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^BH[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"BH","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:assign","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations":{"get":{"summary":"List authorized conversations and collaboration state","tags":["conversations"],"parameters":[{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"inboxSid","required":false},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"senderSid","required":false},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"contactSid","required":false},{"schema":{"anyOf":[{"type":"string","enum":["OPEN"]},{"type":"string","enum":["IDLE"]},{"type":"string","enum":["CLOSED"]},{"type":"string","enum":["ARCHIVED"]}]},"in":"query","name":"state","required":false},{"schema":{"maxLength":128,"type":"string"},"in":"query","name":"assignee","required":false},{"schema":{"type":"boolean"},"in":"query","name":"unassigned","required":false},{"schema":{"type":"boolean"},"in":"query","name":"unread","required":false},{"schema":{"anyOf":[{"type":"string","enum":["LOW"]},{"type":"string","enum":["NORMAL"]},{"type":"string","enum":["HIGH"]},{"type":"string","enum":["URGENT"]}]},"in":"query","name":"priority","required":false},{"schema":{"pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","type":"string"},"in":"query","name":"tag","required":false},{"schema":{"pattern":"^CP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"campaignSid","required":false},{"schema":{"anyOf":[{"type":"string","enum":["OPTED_IN"]},{"type":"string","enum":["OPTED_OUT"]},{"type":"string","enum":["UNKNOWN"]},{"type":"string","enum":["REVOKED"]},{"type":"string","enum":["EXPIRED"]}]},"in":"query","name":"consentState","required":false},{"schema":{"type":"boolean"},"in":"query","name":"riskFlag","required":false},{"schema":{"anyOf":[{"type":"string","enum":["healthy"]},{"type":"string","enum":["at_risk"]},{"type":"string","enum":["breached"]}]},"in":"query","name":"slaState","required":false},{"schema":{"type":"boolean"},"in":"query","name":"snoozed","required":false},{"schema":{"type":"boolean"},"in":"query","name":"waiting","required":false,"description":"Only open conversations where the customer's last message has not been answered."},{"schema":{"anyOf":[{"type":"string","enum":["recent"]},{"type":"string","enum":["longest_waiting"]}]},"in":"query","name":"sort","required":false,"description":"`recent` (default): newest activity first. `longest_waiting`: the customer who has waited longest for a reply first; conversations nobody is waiting on come last."},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"createdAfter","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"createdBefore","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:read","resourceSelector":"accessible_inbox_collection","collectionFilter":"MEMBER_READABLE_INBOXES","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"List conversations you may see, with their state, assignee and service-window expiry.\n\nAccount-scoped credential: Required scope: `conversations:read`.\n\nAlternatively, a normal tenant USER session may use `conversations:read` through actual readable inbox membership in this workspace. Collection results include only accessible inboxes or their conversations; this grants no account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/search":{"get":{"summary":"Search authorized conversations by identifier, contact and metadata","tags":["conversations"],"description":"`q` matches the conversation sid, the contact sid and the contact display name. Message bodies are sealed at rest (§130.1) and are not searchable.\n\nRequired scope: `conversations:read`.","parameters":[{"schema":{"minLength":1,"maxLength":200,"type":"string"},"in":"query","name":"q","required":true},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"inboxSid","required":false},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"senderSid","required":false},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"contactSid","required":false},{"schema":{"maxLength":40,"type":"string"},"in":"query","name":"tag","required":false},{"schema":{"maxLength":128,"type":"string"},"in":"query","name":"assignee","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"from","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"to","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"]}},"/v1/accounts/{AC}/conversations/{CO}":{"get":{"summary":"Get a conversation","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"title":"ConversationDetail","type":"object","required":["object","sid","resourcePermissions","replySender"],"properties":{"object":{"type":"string","enum":["conversation"]},"sid":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"resourcePermissions":{"description":"Effective bounded capabilities for this conversation’s inbox; this readback does not grant account-wide permissions.","type":"array","items":{"anyOf":[{"type":"string","enum":["conversations:read"]},{"type":"string","enum":["conversations:write"]},{"type":"string","enum":["conversations:note"]},{"type":"string","enum":["conversations:assign"]},{"type":"string","enum":["messages:send"]},{"type":"string","enum":["inboxes:read"]}]}},"replySender":{"anyOf":[{"additionalProperties":false,"type":"object","required":["sid","wabaSid","displayName","displayPhoneNumber"],"properties":{"sid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"wabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"displayName":{"type":"string"},"displayPhoneNumber":{"type":"string"}}},{"type":"null"}]}}},"example":{"object":"conversation","sid":"CO01J8Z3K4M5N6P7Q8R9S0T1V2W3","resourcePermissions":["conversations:read"],"replySender":{"sid":"WA01J8Z3K4M5N6P7Q8R9S0T1V2W3","wabaSid":"WB01J8Z3K4M5N6P7Q8R9S0T1V2W3","displayName":"displayName","displayPhoneNumber":"displayPhoneNumber"}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:read","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Fetch one conversation with its assignment, tags and version.\n\nAccount-scoped credential: Required scope: `conversations:read`.\n\nAlternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/messages":{"get":{"summary":"List retained message history for an authorized conversation","tags":["conversations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:read","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"List the messages of a conversation, oldest first.\n\nAccount-scoped credential: Required scope: `conversations:read`.\n\nAlternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/assignments":{"get":{"summary":"List audited assignment and handoff history","tags":["conversations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:read","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:read`.\n\nAlternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/assign":{"post":{"summary":"Assign a conversation","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","assigneePrincipalRef","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"assigneePrincipalRef":{"minLength":1,"maxLength":128,"type":"string"},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}},"example":{"conversationVersion":3,"assigneePrincipalRef":"US01J8Z3K4M5N6P7Q8R9S0T1V2W3","reason":"Billing question"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:assign"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:assign","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Assign a conversation to an available teammate in its inbox, by their principal reference. Send the `conversationVersion` you last read; a stale version is refused so two people cannot overwrite each other.\n\nAccount-scoped credential: Required scope: `conversations:assign`.\n\nAlternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/release":{"post":{"summary":"Release a conversation assignment","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:assign"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:assign","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:assign`.\n\nAlternatively, a normal tenant USER session may use `conversations:assign` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/close":{"post":{"summary":"Close a conversation","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}},"example":{"conversationVersion":4,"reason":"Resolved"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Close a conversation. Send the `conversationVersion` you last read.\n\nAccount-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/reopen":{"post":{"summary":"Reopen a conversation","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/snooze":{"post":{"summary":"Snooze a conversation until a durable follow-up time","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","until","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"until":{"format":"date-time","type":"string"},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/unsnooze":{"post":{"summary":"Return a snoozed conversation to its queue","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/priority":{"post":{"summary":"Change conversation priority and recalculate its SLA clocks","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion","priority","reason"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"priority":{"anyOf":[{"type":"string","enum":["LOW"]},{"type":"string","enum":["NORMAL"]},{"type":"string","enum":["HIGH"]},{"type":"string","enum":["URGENT"]}]},"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/read":{"post":{"summary":"Advance this principal's read cursor","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"lastReadMessageSid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/claim":{"post":{"summary":"Acquire the exclusive composer claim","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["conversationVersion"],"properties":{"conversationVersion":{"minimum":1,"type":"integer"},"leaseSeconds":{"minimum":15,"maximum":300,"type":"integer"},"overrideReason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/claim/renew":{"post":{"summary":"Renew the composer claim","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["leaseToken"],"properties":{"leaseToken":{"format":"uuid","type":"string"},"leaseSeconds":{"minimum":15,"maximum":300,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/claim/release":{"post":{"summary":"Release the composer claim","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["leaseToken"],"properties":{"leaseToken":{"format":"uuid","type":"string"},"leaseSeconds":{"minimum":15,"maximum":300,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/notes":{"get":{"summary":"List encrypted internal notes","tags":["conversations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:read","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:read`.\n\nAlternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."},"post":{"summary":"Create an encrypted internal note","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":20000,"type":"string"},"mentionedPrincipalRefs":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:note"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:note","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:note`.\n\nAlternatively, a normal tenant USER session may use `conversations:note` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/notes/{NT}":{"patch":{"summary":"Edit an internal note","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":20000,"type":"string"},"mentionedPrincipalRefs":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"maxLength":128,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^NT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"NT","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:note"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:note","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:note`.\n\nAlternatively, a normal tenant USER session may use `conversations:note` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."},"delete":{"summary":"Delete an internal note","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^NT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"NT","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:note"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:note","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:note`.\n\nAlternatively, a normal tenant USER session may use `conversations:note` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/saved-replies":{"get":{"summary":"List account saved replies","tags":["conversations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"description":"Required scope: `conversations:read`."},"post":{"summary":"Create a saved reply","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["title","shortcut","body"],"properties":{"title":{"minLength":1,"maxLength":128,"type":"string"},"shortcut":{"pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","type":"string"},"body":{"minLength":1,"maxLength":20000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"description":"Required scope: `conversations:write`."}},"/v1/accounts/{AC}/saved-replies/{SR}":{"patch":{"summary":"Update a saved reply","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["title","shortcut","body"],"properties":{"title":{"minLength":1,"maxLength":128,"type":"string"},"shortcut":{"pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","type":"string"},"body":{"minLength":1,"maxLength":20000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SR[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SR","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"description":"Required scope: `conversations:write`."},"delete":{"summary":"Delete a saved reply","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SR[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SR","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"description":"Required scope: `conversations:write`."}},"/v1/accounts/{AC}/saved-replies/{SR}/versions":{"get":{"summary":"List the immutable versions of a saved reply, newest first","tags":["conversations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SR[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SR","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"description":"Required scope: `conversations:read`."}},"/v1/accounts/{AC}/conversations/{CO}/collaborators":{"get":{"summary":"List conversation collaborators and followers","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:read","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:read`.\n\nAlternatively, a normal tenant USER session may use `conversations:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/collaborators/{principalRef}":{"put":{"summary":"Add a conversation collaborator","tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["role"],"properties":{"role":{"anyOf":[{"type":"string","enum":["COLLABORATOR"]},{"type":"string","enum":["FOLLOWER"]}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"minLength":1,"maxLength":128,"type":"string"},"in":"path","name":"principalRef","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."},"delete":{"summary":"Remove a conversation collaborator","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"minLength":1,"maxLength":128,"type":"string"},"in":"path","name":"principalRef","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/conversations/{CO}/tags/{tag}":{"post":{"summary":"Add a conversation tag","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","type":"string"},"in":"path","name":"tag","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."},"delete":{"summary":"Remove a conversation tag","tags":["conversations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","type":"string"},"in":"path","name":"tag","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"conversation","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `conversations:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/inboxes":{"post":{"summary":"Create a shared inbox","tags":["inboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","senderSids"],"properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"senderSids":{"uniqueItems":true,"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"bindings":{"maxItems":500,"type":"array","items":{"additionalProperties":false,"type":"object","required":["principalType","principalRef","role"],"properties":{"principalType":{"anyOf":[{"type":"string","enum":["USER"]},{"type":"string","enum":["API_KEY"]}]},"principalRef":{"minLength":1,"maxLength":128,"type":"string"},"role":{"anyOf":[{"type":"string","enum":["MESSAGING_OPERATOR"]},{"type":"string","enum":["SUPPORT_MANAGER"]},{"type":"string","enum":["READ_ONLY"]}]}}}},"businessHours":{"additionalProperties":false,"type":"object","required":["timezone","weekly"],"properties":{"timezone":{"minLength":1,"maxLength":64,"type":"string"},"weekly":{"maxItems":21,"type":"array","items":{"additionalProperties":false,"type":"object","required":["days","start","end"],"properties":{"days":{"minItems":1,"maxItems":7,"uniqueItems":true,"type":"array","items":{"minimum":0,"maximum":6,"type":"integer"}},"start":{"pattern":"^(?:[01][0-9]|2[0-3]):[0-5][0-9]$","type":"string"},"end":{"pattern":"^(?:[01][0-9]|2[0-3]):[0-5][0-9]$","type":"string"}}}},"holidays":{"maxItems":366,"uniqueItems":true,"type":"array","items":{"format":"date","type":"string"}}}},"slaPolicy":{"additionalProperties":false,"type":"object","required":["firstResponseSeconds","nextResponseSeconds","resolutionSeconds"],"properties":{"firstResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"nextResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"resolutionSeconds":{"minimum":1,"maximum":2592000,"type":"integer"}}},"slaPolicies":{"minItems":4,"maxItems":4,"type":"array","items":{"additionalProperties":false,"type":"object","required":["priority","firstResponseSeconds","nextResponseSeconds","resolutionSeconds"],"properties":{"priority":{"anyOf":[{"type":"string","enum":["LOW"]},{"type":"string","enum":["NORMAL"]},{"type":"string","enum":["HIGH"]},{"type":"string","enum":["URGENT"]}]},"firstResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"nextResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"resolutionSeconds":{"minimum":1,"maximum":2592000,"type":"integer"}}}},"isDefault":{"type":"boolean"},"assignmentStrategy":{"anyOf":[{"type":"string","enum":["ROUND_ROBIN"]},{"type":"string","enum":["LEAST_LOADED"]},{"type":"string","enum":["BALANCED"]}]},"defaultAgentCapacity":{"minimum":1,"maximum":1000,"type":"integer"},"autoAssign":{"description":"Hand new and queued conversations to available members by the assignment strategy when no routing rule decides. On by default.","type":"boolean"},"reopenAfterSeconds":{"minimum":0,"maximum":31536000,"description":"A customer writing to a closed conversation after this quiet period starts a fresh conversation with fresh deadlines. Default 86400 (24 hours).","type":"integer"},"slaWarningPercent":{"minimum":10,"maximum":99,"description":"Warn the assignee when this share of a response target has elapsed. Default 80.","type":"integer"},"leadPrincipalRef":{"description":"The team lead told about every missed target in this inbox.","anyOf":[{"minLength":1,"maxLength":128,"type":"string"},{"type":"null"}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."},"get":{"summary":"List authorized inboxes","tags":["inboxes"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"type":"boolean"},"in":"query","name":"includeSupervision","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"inboxes:read","resourceSelector":"accessible_inbox_collection","collectionFilter":"MEMBER_READABLE_INBOXES","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `inboxes:read`.\n\nAlternatively, a normal tenant USER session may use `inboxes:read` through actual readable inbox membership in this workspace. Collection results include only accessible inboxes or their conversations; this grants no account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/inboxes/{IB}":{"get":{"summary":"Get an inbox","tags":["inboxes"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"patch":{"summary":"Update an inbox","tags":["inboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"name":{"minLength":1,"maxLength":128,"type":"string"},"senderSids":{"uniqueItems":true,"type":"array","items":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"bindings":{"maxItems":500,"type":"array","items":{"additionalProperties":false,"type":"object","required":["principalType","principalRef","role"],"properties":{"principalType":{"anyOf":[{"type":"string","enum":["USER"]},{"type":"string","enum":["API_KEY"]}]},"principalRef":{"minLength":1,"maxLength":128,"type":"string"},"role":{"anyOf":[{"type":"string","enum":["MESSAGING_OPERATOR"]},{"type":"string","enum":["SUPPORT_MANAGER"]},{"type":"string","enum":["READ_ONLY"]}]}}}},"businessHours":{"additionalProperties":false,"type":"object","required":["timezone","weekly"],"properties":{"timezone":{"minLength":1,"maxLength":64,"type":"string"},"weekly":{"maxItems":21,"type":"array","items":{"additionalProperties":false,"type":"object","required":["days","start","end"],"properties":{"days":{"minItems":1,"maxItems":7,"uniqueItems":true,"type":"array","items":{"minimum":0,"maximum":6,"type":"integer"}},"start":{"pattern":"^(?:[01][0-9]|2[0-3]):[0-5][0-9]$","type":"string"},"end":{"pattern":"^(?:[01][0-9]|2[0-3]):[0-5][0-9]$","type":"string"}}}},"holidays":{"maxItems":366,"uniqueItems":true,"type":"array","items":{"format":"date","type":"string"}}}},"slaPolicy":{"additionalProperties":false,"type":"object","required":["firstResponseSeconds","nextResponseSeconds","resolutionSeconds"],"properties":{"firstResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"nextResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"resolutionSeconds":{"minimum":1,"maximum":2592000,"type":"integer"}}},"slaPolicies":{"minItems":4,"maxItems":4,"type":"array","items":{"additionalProperties":false,"type":"object","required":["priority","firstResponseSeconds","nextResponseSeconds","resolutionSeconds"],"properties":{"priority":{"anyOf":[{"type":"string","enum":["LOW"]},{"type":"string","enum":["NORMAL"]},{"type":"string","enum":["HIGH"]},{"type":"string","enum":["URGENT"]}]},"firstResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"nextResponseSeconds":{"minimum":1,"maximum":2592000,"type":"integer"},"resolutionSeconds":{"minimum":1,"maximum":2592000,"type":"integer"}}}},"isDefault":{"type":"boolean"},"assignmentStrategy":{"anyOf":[{"type":"string","enum":["ROUND_ROBIN"]},{"type":"string","enum":["LEAST_LOADED"]},{"type":"string","enum":["BALANCED"]}]},"defaultAgentCapacity":{"minimum":1,"maximum":1000,"type":"integer"},"autoAssign":{"description":"Hand new and queued conversations to available members by the assignment strategy when no routing rule decides. On by default.","type":"boolean"},"reopenAfterSeconds":{"minimum":0,"maximum":31536000,"description":"A customer writing to a closed conversation after this quiet period starts a fresh conversation with fresh deadlines. Default 86400 (24 hours).","type":"integer"},"slaWarningPercent":{"minimum":10,"maximum":99,"description":"Warn the assignee when this share of a response target has elapsed. Default 80.","type":"integer"},"leadPrincipalRef":{"description":"The team lead told about every missed target in this inbox.","anyOf":[{"minLength":1,"maxLength":128,"type":"string"},{"type":"null"}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."},"delete":{"summary":"Delete an empty non-default inbox","tags":["inboxes"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/inboxes/{IB}/routing-rules":{"get":{"summary":"List ordered routing rules","tags":["inboxes"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"post":{"summary":"Create a routing rule","tags":["inboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["priority","match","action"],"properties":{"priority":{"minimum":1,"maximum":10000,"description":"Evaluation order. Enabled rules are tried from the highest number down and the first match wins; rules sharing a number are tried in creation order. Give specific rules a higher number than generic catch-all rules.","type":"integer"},"match":{"additionalProperties":true,"type":"object","properties":{}},"action":{"anyOf":[{"type":"string","enum":["ASSIGN_ROUND_ROBIN"]},{"type":"string","enum":["ASSIGN_LEAST_LOADED"]},{"type":"string","enum":["ASSIGN_BALANCED"]},{"type":"string","enum":["ASSIGN_PRINCIPAL"]},{"type":"string","enum":["QUEUE"]},{"type":"string","enum":["BOT_HANDOFF"]}]},"actionTarget":{"minLength":1,"maxLength":128,"type":"string"},"enabled":{"type":"boolean"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/inboxes/{IB}/routing-rules/{ruleId}":{"patch":{"summary":"Update a routing rule","tags":["inboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"priority":{"minimum":1,"maximum":10000,"description":"Evaluation order. Enabled rules are tried from the highest number down and the first match wins; rules sharing a number are tried in creation order. Give specific rules a higher number than generic catch-all rules.","type":"integer"},"match":{"additionalProperties":true,"type":"object","properties":{}},"action":{"anyOf":[{"type":"string","enum":["ASSIGN_ROUND_ROBIN"]},{"type":"string","enum":["ASSIGN_LEAST_LOADED"]},{"type":"string","enum":["ASSIGN_BALANCED"]},{"type":"string","enum":["ASSIGN_PRINCIPAL"]},{"type":"string","enum":["QUEUE"]},{"type":"string","enum":["BOT_HANDOFF"]}]},"actionTarget":{"minLength":1,"maxLength":128,"type":"string"},"enabled":{"type":"boolean"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"ruleId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."},"delete":{"summary":"Delete a routing rule","tags":["inboxes"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"ruleId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/inboxes/{IB}/routing-rules/dry-run":{"post":{"summary":"Evaluate routing rules without mutation","tags":["inboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["senderSid","contactSid","trigger"],"properties":{"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"trigger":{"anyOf":[{"type":"string","enum":["INBOUND"]},{"type":"string","enum":["OUTBOUND"]}]},"keywordText":{"maxLength":4096,"type":"string"},"occurredAt":{"format":"date-time","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/inboxes/{IB}/presence":{"get":{"summary":"List live agent presence","tags":["inboxes"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"inboxes:read","resourceSelector":"inbox","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `inboxes:read`.\n\nAlternatively, a normal tenant USER session may use `inboxes:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."},"post":{"summary":"Heartbeat agent presence","tags":["inboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["leaseId","state"],"properties":{"leaseId":{"format":"uuid","type":"string"},"state":{"anyOf":[{"type":"string","enum":["AVAILABLE"]},{"type":"string","enum":["BUSY"]},{"type":"string","enum":["AWAY"]},{"type":"string","enum":["OFFLINE"]}]},"capacity":{"minimum":1,"maximum":1000,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"conversations:write","resourceSelector":"inbox","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `inboxes:write`.\n\nAlternatively, a normal tenant USER session may use `conversations:write` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/inboxes/{IB}/members":{"get":{"summary":"List the people who can be assigned this inbox's conversations","tags":["inboxes"],"description":"Inbox members and the business's owners and admins, with their name, whether they are available now, and how many open conversations they hold. Manual assignment accepts any of them; automatic assignment uses only those available with free capacity.\n\nAccount-scoped credential: Required scope: `inboxes:read`.\n\nAlternatively, a normal tenant USER session may use `inboxes:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"inboxes:read","resourceSelector":"inbox","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true}}},"/v1/accounts/{AC}/inboxes/{IB}/queue":{"get":{"summary":"Get supervisor queue state","tags":["inboxes"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"IB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"x-resource-authorization-alternative":{"principalKind":"USER","resourceType":"INBOX","permission":"inboxes:read","resourceSelector":"inbox","excludesApiKeys":true,"excludesStaffDelegation":true,"excludesPlatformAccess":true},"description":"Account-scoped credential: Required scope: `inboxes:read`.\n\nAlternatively, a normal tenant USER session may use `inboxes:read` on the exact inbox resolved from this resource. Actual inbox membership, tenant/subaccount visibility and per-operation checks still apply. This does not grant account-wide scopes, API-key permission, staff-delegation authority or platform access."}},"/v1/accounts/{AC}/csat/settings":{"get":{"summary":"Get customer satisfaction survey settings","tags":["csat"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."},"put":{"summary":"Configure customer satisfaction surveys","tags":["csat"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","minimumRating","maximumRating","responseWindowDays","requireServiceConsent","retainDays"],"properties":{"enabled":{"type":"boolean"},"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"contentSid":{"pattern":"^HX[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"minimumRating":{"minimum":0,"maximum":9,"type":"integer"},"maximumRating":{"minimum":1,"maximum":10,"type":"integer"},"responseWindowDays":{"minimum":1,"maximum":90,"type":"integer"},"requireServiceConsent":{"type":"boolean"},"retainDays":{"minimum":1,"maximum":3650,"type":"integer"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/conversations/{CO}/csat-surveys":{"post":{"summary":"Create a survey for a closed conversation","tags":["csat"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"],"description":"Required scope: `conversations:write`."},"get":{"summary":"Read the survey decision for a conversation","tags":["csat"],"description":"§147.4: every closed conversation under an enabled policy carries exactly one survey decision, made by the platform. The list holds that decision or nothing.\n\nRequired scope: `conversations:read`.","parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:read"]}},"/v1/accounts/{AC}/conversations/{CO}/csat-surveys/re-evaluate":{"post":{"summary":"Ask the platform to re-evaluate a refused survey","tags":["csat"],"description":"Only a CANCELED decision can be re-evaluated; the maintenance worker re-runs eligibility and either dispatches the survey or records the new refusal reason.\n\nRequired scope: `conversations:write`.","parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CO","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["conversations:write"]}},"/v1/accounts/{AC}/csat-surveys/{SV}/dispatched":{"post":{"summary":"Link a dispatched survey to its message","tags":["csat"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["messageSid"],"properties":{"messageSid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^SV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SV","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/csat/{SV}":{"get":{"summary":"Read a public customer satisfaction survey","tags":["csat"],"parameters":[{"schema":{"minLength":32,"maxLength":256,"type":"string"},"in":"query","name":"token","required":true},{"schema":{"pattern":"^SV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SV","required":true}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/csat/{SV}/responses":{"post":{"summary":"Submit a public customer satisfaction response","tags":["csat"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["token","rating"],"properties":{"token":{"minLength":32,"maxLength":256,"type":"string"},"rating":{"minimum":0,"maximum":10,"type":"integer"},"comment":{"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^SV[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SV","required":true}],"security":[],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/accounts/{AC}/csat/analytics":{"get":{"summary":"Report customer satisfaction outcomes by inbox and agent","tags":["csat","analytics"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["analytics:read"],"description":"Required scope: `analytics:read`."}},"/v1/accounts/{AC}/workflows":{"get":{"summary":"List workflow automations","tags":["workflows"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"post":{"summary":"Create a draft workflow automation","tags":["workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","definition"],"properties":{"name":{"minLength":1,"maxLength":160,"type":"string"},"definition":{"additionalProperties":false,"type":"object","required":["trigger","conditions","actions"],"properties":{"trigger":{"additionalProperties":false,"type":"object","required":["eventTypes"],"properties":{"eventTypes":{"minItems":1,"maxItems":20,"type":"array","items":{"pattern":"^[A-Z][A-Z0-9_]{2,63}$","type":"string"}},"allowReentry":{"type":"boolean"},"timeoutSeconds":{"minimum":1,"maximum":2592000,"type":"integer"}}},"conditions":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["field","operator","value"],"properties":{"field":{"minLength":1,"maxLength":100,"type":"string"},"operator":{"anyOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["not_equals"]},{"type":"string","enum":["contains"]}]},"value":{}}}},"actions":{"minItems":1,"maxItems":25,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"failureActions":{"maxItems":10,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"timeoutActions":{"maxItems":10,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/workflows/{WF}":{"get":{"summary":"Get a workflow and its latest definition","tags":["workflows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."},"delete":{"summary":"Delete a workflow that is not published","tags":["workflows"],"description":"Removes a DRAFT or STOPPED workflow with its versions and finished runs. A PUBLISHED workflow must be stopped first; a workflow with RUNNING or WAITING runs is refused until those runs are stopped.\n\nRequired scope: `inboxes:write`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"]}},"/v1/accounts/{AC}/workflows/{WF}/versions":{"post":{"summary":"Create an immutable workflow version","tags":["workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["trigger","conditions","actions"],"properties":{"trigger":{"additionalProperties":false,"type":"object","required":["eventTypes"],"properties":{"eventTypes":{"minItems":1,"maxItems":20,"type":"array","items":{"pattern":"^[A-Z][A-Z0-9_]{2,63}$","type":"string"}},"allowReentry":{"type":"boolean"},"timeoutSeconds":{"minimum":1,"maximum":2592000,"type":"integer"}}},"conditions":{"maxItems":20,"type":"array","items":{"additionalProperties":false,"type":"object","required":["field","operator","value"],"properties":{"field":{"minLength":1,"maxLength":100,"type":"string"},"operator":{"anyOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["not_equals"]},{"type":"string","enum":["contains"]}]},"value":{}}}},"actions":{"minItems":1,"maxItems":25,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"failureActions":{"maxItems":10,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"timeoutActions":{"maxItems":10,"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/workflows/{WF}/publish":{"post":{"summary":"Publish a workflow automation","tags":["workflows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/workflows/{WF}/stop":{"post":{"summary":"Stop a workflow automation","tags":["workflows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/workflows/{WF}/test":{"post":{"summary":"Start an isolated workflow test run","tags":["workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["eventType"],"properties":{"eventType":{"pattern":"^[A-Z][A-Z0-9_]{2,63}$","type":"string"},"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"conversationSid":{"pattern":"^CO[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"messageSid":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"payload":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/workflows/{WF}/runs":{"get":{"summary":"List durable workflow runs and outcomes","tags":["workflows"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:read"],"description":"Required scope: `inboxes:read`."}},"/v1/accounts/{AC}/workflows/{WF}/runs/{WR}/stop":{"post":{"summary":"Stop one durable workflow run without stopping the workflow","tags":["workflows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"pattern":"^WR[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WR","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}/workflows/{WF}/contacts/{CT}/stop":{"post":{"summary":"Stop a workflow for one contact without stopping the workflow","tags":["workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"reason":{"minLength":1,"maxLength":500,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."},"delete":{"summary":"Resume a workflow for one stopped contact","tags":["workflows"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^WF[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WF","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["inboxes:write"],"description":"Required scope: `inboxes:write`."}},"/v1/accounts/{AC}":{"get":{"summary":"Get the authenticated account","tags":["accounts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"patch":{"summary":"Update the authenticated account","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":2,"type":"object","required":["reason"],"properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"},"homeRegion":{"minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$","type":"string"},"autoReadReceipts":{"type":"boolean"},"consentPolicy":{"anyOf":[{"type":"string","enum":["STRICT"]},{"type":"string","enum":["STANDARD"]}]},"timezone":{"description":"IANA time zone the account schedules in (for example Africa/Lagos). null returns to the zone of the organization's country.","anyOf":[{"minLength":1,"maxLength":64,"type":"string"},{"type":"null"}]},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/subaccounts":{"get":{"summary":"List subaccounts","tags":["accounts"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"post":{"summary":"Create a subaccount","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["displayName"],"properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/subaccounts/{SA}":{"get":{"summary":"Get a subaccount","tags":["accounts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"patch":{"summary":"Update a subaccount","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["displayName"],"properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."},"delete":{"summary":"Close an empty subaccount","tags":["accounts"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/users":{"get":{"summary":"List organization users","tags":["users"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:read"],"description":"Required scope: `users:read`."},"post":{"summary":"Invite an organization user","tags":["users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["email","displayName","role","stepUpToken"],"properties":{"email":{"format":"email","maxLength":320,"type":"string"},"displayName":{"minLength":1,"maxLength":128,"type":"string"},"role":{"minLength":1,"maxLength":64,"type":"string"},"scopeKind":{"anyOf":[{"type":"string","enum":["ORGANIZATION"]},{"type":"string","enum":["ACCOUNT"]},{"type":"string","enum":["SUBACCOUNT"]},{"type":"string","enum":["INBOX"]}]},"inboxSid":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"environment":{"anyOf":[{"type":"string","enum":["live"]},{"type":"string","enum":["sandbox"]},{"type":"string","enum":["both"]}]},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:write"],"description":"Required scope: `users:write`."}},"/v1/accounts/{AC}/users/{US}/invitation":{"post":{"summary":"Resend an invited member's invitation e-mail","tags":["users"],"description":"A2-ROLES-07: for a member still INVITED, issues a fresh invitation link (the previous one stops working) and e-mails it. Grants nothing, so no step-up is asked.\n\nRequired scope: `users:write`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^US[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"US","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:write"]}},"/v1/accounts/{AC}/users/{US}":{"get":{"summary":"Get an organization user","tags":["users"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^US[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"US","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:read"],"description":"Required scope: `users:read`."},"patch":{"summary":"Update an organization user","tags":["users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"},"status":{"anyOf":[{"type":"string","enum":["ACTIVE"]},{"type":"string","enum":["LOCKED"]},{"type":"string","enum":["DISABLED"]}]},"mfaRequired":{"type":"boolean"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^US[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"US","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:write"],"description":"Required scope: `users:write`."},"delete":{"summary":"Disable an organization user","tags":["users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^US[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"US","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:write"],"description":"Required scope: `users:write`."}},"/v1/accounts/{AC}/api-keys/scopes":{"get":{"summary":"List the scopes an API key can be given","tags":["api-keys"],"description":"The scope catalogue, grouped, with plain-language labels (M-38). `held` marks the scopes the caller may put on a new key: a key never exceeds the user or key creating it.\n\nRequired scope: `api_keys:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:read"]}},"/v1/accounts/{AC}/api-keys":{"get":{"summary":"List API key metadata","tags":["api-keys"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:read"],"description":"List API keys: name, scopes, restrictions and last use. Secrets are never shown.\n\nRequired scope: `api_keys:read`."},"post":{"summary":"Create an API key and reveal its secret once","tags":["api-keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["displayName","scopes","stepUpToken"],"properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"},"scopes":{"minItems":1,"maxItems":200,"uniqueItems":true,"type":"array","items":{"pattern":"^(?:[*]|[a-z][a-z0-9_-]*:[a-z*][a-z0-9_*-]*)$","type":"string"}},"subaccountSid":{"pattern":"^SA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"allowedCidrs":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":3,"maxLength":64,"type":"string"}},"requireSigning":{"type":"boolean"},"expiresAt":{"format":"date-time","type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}},"example":{"displayName":"Order service","scopes":["messages:send","messages:read","templates:read"],"stepUpToken":"stp_3b1f0c5e9a7d4e2f8c6b0a9d1e3f5a7c"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:write"],"description":"Create an API key. The secret is in this response only; store it now. Give each key the fewest scopes it needs.\n\nRequired scope: `api_keys:write`."}},"/v1/accounts/{AC}/api-keys/{SK}":{"get":{"summary":"Get API key metadata","tags":["api-keys"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SK","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:read"],"description":"Required scope: `api_keys:read`."},"patch":{"summary":"Update API key restrictions","tags":["api-keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":1,"type":"object","properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"},"allowedCidrs":{"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":3,"maxLength":64,"type":"string"}},"requireSigning":{"type":"boolean"},"expiresAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SK","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:write"],"description":"Required scope: `api_keys:write`."}},"/v1/accounts/{AC}/api-keys/{SK}/rotate":{"post":{"summary":"Rotate an API key and reveal the replacement secret once","tags":["api-keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","stepUpToken"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"},"overlapHours":{"minimum":0,"maximum":168,"description":"Hours the current secret stays valid beside the new one. Default 24; 0 ends it immediately; at most 168 (7 days).","type":"integer"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}},"example":{"reason":"Quarterly rotation","stepUpToken":"stp_3b1f0c5e9a7d4e2f8c6b0a9d1e3f5a7c"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SK","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:write"],"description":"Replace a key's secret. The response shows the new secret once; store it now.\n\nRequired scope: `api_keys:write`."}},"/v1/accounts/{AC}/api-keys/{SK}/end-overlap":{"post":{"summary":"Stop the replaced secret of a rotated API key working now","tags":["api-keys"],"description":"After a rotation the previous secret keeps working until previousSecretExpiresAt. Call this once every client uses the new secret. It only narrows access, so it needs no step-up.\n\nRequired scope: `api_keys:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SK","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:write"]}},"/v1/accounts/{AC}/api-keys/{SK}/disable":{"post":{"summary":"Disable an API key","tags":["api-keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","stepUpToken"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SK","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:write"],"description":"Required scope: `api_keys:write`."}},"/v1/accounts/{AC}/api-keys/{SK}/revoke":{"post":{"summary":"Revoke an API key","tags":["api-keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","stepUpToken"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}},"example":{"reason":"Laptop lost","stepUpToken":"stp_3b1f0c5e9a7d4e2f8c6b0a9d1e3f5a7c"}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"SK","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}},"example":{}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api_keys:write"],"description":"Revoke a key immediately and for good. A revoked key is never re-enabled.\n\nRequired scope: `api_keys:write`."}},"/v1/accounts/{AC}/sandbox-explorer":{"post":{"summary":"Execute an allow-listed request with an owned sandbox key","tags":["sandbox"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["apiKeySid","method","path"],"properties":{"apiKeySid":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"method":{"anyOf":[{"type":"string","enum":["GET"]},{"type":"string","enum":["POST"]},{"type":"string","enum":["PUT"]},{"type":"string","enum":["PATCH"]}]},"path":{"minLength":1,"maxLength":1000,"type":"string"},"body":{}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/organization":{"get":{"summary":"Get the owning organization","tags":["accounts"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["users:read"],"description":"Required scope: `users:read`."},"patch":{"summary":"Update the owning organization","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":2,"type":"object","required":["reason"],"properties":{"legalName":{"minLength":1,"maxLength":200,"type":"string"},"displayName":{"minLength":1,"maxLength":128,"type":"string"},"country":{"pattern":"^[A-Z]{2}$","type":"string"},"defaultCurrency":{"pattern":"^[A-Z]{3}$","type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/organization/accounts":{"get":{"summary":"List organization accounts","tags":["accounts"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"post":{"summary":"Create an account in the organization","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["displayName","homeRegion","reason"],"properties":{"displayName":{"minLength":1,"maxLength":128,"type":"string"},"homeRegion":{"minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$","type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["organization:write"],"description":"Required scope: `organization:write`."}},"/v1/accounts/{AC}/organization/close":{"post":{"summary":"Irreversibly close the organization","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","reason","caseRef","confirmation"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"confirmation":{"minLength":28,"maxLength":28,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["organization:delete"],"description":"Required scope: `organization:delete`."}},"/v1/accounts/{AC}/close":{"post":{"summary":"Irreversibly close the authenticated account","tags":["accounts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","reason","caseRef","confirmation"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"confirmation":{"minLength":28,"maxLength":28,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["organization:delete"],"description":"Required scope: `organization:delete`."}},"/v1/accounts/{AC}/portfolios":{"get":{"summary":"List Meta Business Portfolios and independently scoped limits","tags":["provider","senders"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["portfolios:read"],"description":"Required scope: `portfolios:read`."}},"/v1/accounts/{AC}/wabas/{WB}":{"get":{"summary":"Get a WABA with its portfolio, connection and sender state","tags":["provider","senders"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["wabas:read"],"description":"Required scope: `wabas:read`."}},"/v1/accounts/{AC}/wabas/{WB}/reconnect":{"post":{"summary":"Start a fresh Embedded Signup reconnection for a disconnected WABA","tags":["provider","senders","operations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","reason","caseRef"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["wabas:write"],"description":"Required scope: `wabas:write`."}},"/v1/accounts/{AC}/wabas/{WB}/reconcile-subscription":{"post":{"summary":"Reconcile WABA subscription and callback override as an Operation","tags":["provider","operations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","caseRef"],"properties":{"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WB","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["wabas:write"],"description":"Required scope: `wabas:write`."}},"/v1/accounts/{AC}/senders/{WA}/business-profile":{"get":{"summary":"Get the current reconciled WhatsApp business profile","tags":["senders","profiles"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["business_profiles:read"],"description":"Required scope: `business_profiles:read`."},"patch":{"summary":"Create an Operation-backed WhatsApp business profile update","tags":["senders","profiles","operations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"minProperties":2,"type":"object","required":["reason"],"properties":{"about":{"anyOf":[{"maxLength":139,"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"maxLength":512,"type":"string"},{"type":"null"}]},"category":{"anyOf":[{"maxLength":128,"type":"string"},{"type":"null"}]},"websites":{"maxItems":2,"type":"array","items":{"format":"uri","maxLength":2048,"type":"string"}},"address":{"anyOf":[{"maxLength":256,"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"format":"email","maxLength":320,"type":"string"},{"type":"null"}]},"profileImageMediaSid":{"anyOf":[{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},{"type":"null"}]},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"WA","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["business_profiles:write"],"description":"Required scope: `business_profiles:write`."}},"/v1/accounts/{AC}/migrations":{"post":{"summary":"Authorize a preflighted phone-number migration Operation","tags":["migrations","senders","operations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["senderSid","destinationWabaSid","countryCode","phoneNumber","registrationPin","stepUpToken","reason","caseRef","validation"],"properties":{"senderSid":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"sourceWabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"destinationWabaSid":{"pattern":"^WB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"countryCode":{"pattern":"^[0-9]{1,3}$","type":"string"},"phoneNumber":{"pattern":"^[0-9]{4,15}$","type":"string"},"registrationPin":{"pattern":"^[0-9]{6}$","type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"validation":{"additionalProperties":false,"type":"object","required":["contactSid","templateSid"],"properties":{"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"templateSid":{"pattern":"^TM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["migrations:write"],"description":"Required scope: `migrations:write`."},"get":{"summary":"List Meta asset migration Operations","tags":["migrations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["migrations:read"],"description":"Required scope: `migrations:read`."}},"/v1/accounts/{AC}/migrations/{OP}":{"get":{"summary":"Get a Meta asset migration and its Operation history","tags":["migrations","operations"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["migrations:read"],"description":"Required scope: `migrations:read`."}},"/v1/accounts/{AC}/migrations/{OP}/registration-pin":{"post":{"summary":"Resume a migration waiting for a corrected registration PIN","tags":["migrations","operations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["registrationPin","stepUpToken","reason","caseRef"],"properties":{"registrationPin":{"pattern":"^[0-9]{6}$","type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^OP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"OP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["migrations:write"],"description":"Required scope: `migrations:write`."}},"/v1/accounts/{AC}/provider-changes":{"get":{"summary":"List provider version, policy, pricing and capability changes","tags":["provider"],"description":"The §125 change feed: the provider version calendar plus the customer-visible Provider Change Center entries. Several §138 dates are month-only, which datePrecision states rather than implying a day the provider never published.\n\nRequired scope: `provider_changes:read`.","parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["provider_changes:read"]}},"/v1/accounts/{AC}/provider-version-calendar":{"get":{"summary":"Provider Graph API version state per environment","tags":["provider"],"description":"META-011 (§21.1a): for every environment the pinned version, its Meta deprecation date and precision from the §125 calendar, the next non-retired version, and the latest canary with its contract-test evidence. The calendar itself is returned alongside.\n\nRequired scope: `provider_changes:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["provider_changes:read"]}},"/v1/accounts/{AC}/provider-capabilities":{"get":{"summary":"List effective provider capabilities by governed scope","tags":["provider"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["provider_changes:read"],"description":"Required scope: `provider_changes:read`."}},"/v1/accounts/{AC}/identity/step-up":{"post":{"summary":"Exchange verified MFA or a one-use recovery code for a step-up token","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["action","method","assertion"],"properties":{"action":{"minLength":1,"maxLength":256,"description":"The action the grant is for, exactly as a STEP_UP_REQUIRED refusal names it in details[path=stepUpAction] (for example API_KEY_CREATE, API_KEY_ROTATE, WEBHOOK_ENDPOINT_CREATE, WEBHOOK_URL_CHANGE, WEBHOOK_SECRET_ROTATE, WEBHOOK_ENDPOINT_REENABLE). A grant for another name is not accepted. Step-up is for people signed in to the console; an API key with webhooks:write manages webhook endpoints without it.","type":"string"},"providerKey":{"minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9_-]*$","type":"string"},"method":{"anyOf":[{"type":"string","enum":["WEBAUTHN"]},{"type":"string","enum":["TOTP"]},{"type":"string","enum":["RECOVERY_CODE"]}]},"assertion":{"minLength":1,"maxLength":32768,"type":"string"},"challenge":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/roles":{"get":{"summary":"List authoritative customer roles and permissions","tags":["identity"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write","audit:read"],"description":"Required scope: any one of `roles:write`, `audit:read`."}},"/v1/accounts/{AC}/role-bindings":{"get":{"summary":"List active role bindings in the account scope","tags":["identity"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write","audit:read"],"description":"Required scope: any one of `roles:write`, `audit:read`."},"post":{"summary":"Create an immutable role binding","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["principalType","principalRef","role","scopeKind","stepUpToken"],"properties":{"principalType":{"anyOf":[{"type":"string","enum":["USER"]},{"type":"string","enum":["API_KEY"]}]},"principalRef":{"minLength":1,"maxLength":128,"type":"string"},"role":{"minLength":1,"maxLength":64,"type":"string"},"scopeKind":{"anyOf":[{"type":"string","enum":["ORGANIZATION"]},{"type":"string","enum":["ACCOUNT"]},{"type":"string","enum":["SUBACCOUNT"]},{"type":"string","enum":["INBOX"]}]},"inboxSid":{"pattern":"^IB[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"environment":{"anyOf":[{"type":"string","enum":["live"]},{"type":"string","enum":["sandbox"]},{"type":"string","enum":["both"]}]},"expiresAt":{"format":"date-time","type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/support-cases":{"get":{"summary":"List support cases for the customer account","tags":["support"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant","audit:read"],"description":"Required scope: any one of `support_access:grant`, `audit:read`."},"post":{"summary":"Open a support case","tags":["support"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["kind","priority","summary"],"properties":{"kind":{"anyOf":[{"type":"string","enum":["AMBIGUOUS_SEND"]},{"type":"string","enum":["BILLING"]},{"type":"string","enum":["IDENTITY"]},{"type":"string","enum":["META_ASSET"]},{"type":"string","enum":["PRIVACY"]},{"type":"string","enum":["INCIDENT"]},{"type":"string","enum":["GENERAL"]}]},"priority":{"anyOf":[{"type":"string","enum":["P0"]},{"type":"string","enum":["P1"]},{"type":"string","enum":["P2"]},{"type":"string","enum":["P3"]}]},"summary":{"minLength":1,"maxLength":500,"type":"string"},"resourceRef":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant"],"description":"Required scope: `support_access:grant`."}},"/v1/accounts/{AC}/support-cases/{CS}":{"get":{"summary":"Get a support case and its related audit trail","tags":["support"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant","audit:read"],"description":"Required scope: any one of `support_access:grant`, `audit:read`."}},"/v1/accounts/{AC}/support-cases/{CS}/messages":{"post":{"summary":"Reply to a support case","tags":["support"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["body"],"properties":{"body":{"minLength":1,"maxLength":5000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant"],"description":"Required scope: `support_access:grant`."}},"/v1/accounts/{AC}/support-cases/{CS}/close":{"post":{"summary":"Close a support case","tags":["support"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"body":{"minLength":1,"maxLength":5000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant"],"description":"Required scope: `support_access:grant`."}},"/v1/accounts/{AC}/support-cases/{CS}/reopen":{"post":{"summary":"Reopen a resolved or closed support case","tags":["support"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"body":{"minLength":1,"maxLength":5000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^CS[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CS","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant"],"description":"Required scope: `support_access:grant`."}},"/v1/accounts/{AC}/role-bindings/{bindingId}":{"delete":{"summary":"Revoke an immutable role binding","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","stepUpToken"],"properties":{"reason":{"minLength":1,"maxLength":1000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"bindingId","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/approvals":{"post":{"summary":"Create an approval request","tags":["approvals"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["action","resourceRef","reason","requiredApproverRole"],"properties":{"action":{"minLength":1,"maxLength":128,"pattern":"^[A-Z][A-Z0-9_]*$","type":"string"},"resourceRef":{"minLength":1,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"requiredApproverRole":{"minLength":1,"maxLength":64,"type":"string"},"riskClass":{"anyOf":[{"type":"string","enum":["STANDARD"]},{"type":"string","enum":["HIGH"]},{"type":"string","enum":["CRITICAL"]}]},"expiresAt":{"format":"date-time","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:request"],"description":"Required scope: `approvals:request`."},"get":{"summary":"List approval requests","tags":["approvals"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:read"],"description":"Required scope: `approvals:read`."}},"/v1/accounts/{AC}/approvals/{AP}/approve":{"post":{"summary":"Approve an approval request","tags":["approvals"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["decisionNote"],"properties":{"decisionNote":{"minLength":1,"maxLength":2000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:decide"],"description":"Required scope: `approvals:decide`."}},"/v1/accounts/{AC}/approvals/{AP}/reject":{"post":{"summary":"Reject an approval request","tags":["approvals"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["decisionNote"],"properties":{"decisionNote":{"minLength":1,"maxLength":2000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:decide"],"description":"Required scope: `approvals:decide`."}},"/v1/accounts/{AC}/approvals/{AP}/withdraw":{"post":{"summary":"Withdraw an approval request","tags":["approvals"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AP","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["approvals:request"],"description":"Required scope: `approvals:request`."}},"/v1/accounts/{AC}/support-access/consents":{"post":{"summary":"Create single-use customer consent for delegated support access","tags":["support"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["scopes","caseRef","stepUpToken"],"properties":{"scopes":{"minItems":1,"maxItems":9,"type":"array","items":{"minLength":1,"maxLength":64,"type":"string"}},"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant"],"description":"Required scope: `support_access:grant`."}},"/v1/accounts/{AC}/support-access":{"get":{"summary":"List delegated support-access grants","tags":["support"],"parameters":[{"schema":{"anyOf":[{"type":"string","enum":["active"]},{"type":"string","enum":["history"]},{"type":"string","enum":["all"]}]},"in":"query","name":"state","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant","audit:read"],"description":"Required scope: any one of `support_access:grant`, `audit:read`."}},"/v1/accounts/{AC}/support-access/review":{"get":{"summary":"Quarterly delegated-access review","tags":["support","audit"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["audit:read"],"description":"Required scope: `audit:read`."}},"/v1/accounts/{AC}/support-access/{grantId}":{"get":{"summary":"Get a delegated support-access grant","tags":["support"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"grantId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant","audit:read"],"description":"Required scope: any one of `support_access:grant`, `audit:read`."}},"/v1/accounts/{AC}/support-access/{grantId}/end":{"post":{"summary":"End delegated support access","tags":["support"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"grantId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["support_access:grant","support_access:request"],"description":"Required scope: any one of `support_access:grant`, `support_access:request`."}},"/v1/accounts/{AC}/notifications":{"get":{"summary":"List notifications","tags":["notifications"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"type":"boolean"},"in":"query","name":"unread","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:read"],"description":"Required scope: `notifications:read`."}},"/v1/accounts/{AC}/notifications/{notificationId}/read":{"post":{"summary":"Mark a notification read","tags":["notifications"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"notificationId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:read"],"description":"Required scope: `notifications:read`."}},"/v1/accounts/{AC}/notification-preferences":{"get":{"summary":"List effective notification-category preferences","tags":["notifications"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:write"],"description":"Required scope: `notifications:write`."},"put":{"summary":"Set one notification-category preference","tags":["notifications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["category","inApp","email"],"properties":{"category":{"anyOf":[{"type":"string","enum":["sender_health"]},{"type":"string","enum":["template_status"]},{"type":"string","enum":["action_required"]},{"type":"string","enum":["operation_complete"]},{"type":"string","enum":["security"]},{"type":"string","enum":["incident"]},{"type":"string","enum":["product_update"]},{"type":"string","enum":["billing"]},{"type":"string","enum":["conversation"]}]},"inApp":{"type":"boolean"},"email":{"type":"boolean"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:write"],"description":"Required scope: `notifications:write`."}},"/v1/accounts/{AC}/notification-preferences/language":{"put":{"summary":"Set the signed-in user's language for the console and e-mails","tags":["notifications"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["locale"],"properties":{"locale":{"anyOf":[{"type":"string","enum":["en"]},{"type":"string","enum":["fr"]},{"type":"null"}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["notifications:read"],"description":"Required scope: `notifications:read`."}},"/v1/accounts/{AC}/identity/mfa/enrollments":{"post":{"summary":"Start WebAuthn or TOTP enrollment","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["providerKey","method"],"properties":{"providerKey":{"minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9_-]*$","type":"string"},"method":{"anyOf":[{"type":"string","enum":["WEBAUTHN"]},{"type":"string","enum":["TOTP"]}]},"displayName":{"minLength":1,"maxLength":128,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/identity/mfa/enrollments/{enrollmentId}/complete":{"post":{"summary":"Complete WebAuthn or TOTP enrollment","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["ceremonyRef","response"],"properties":{"ceremonyRef":{"minLength":16,"maxLength":1024,"type":"string"},"response":{"minLength":1,"maxLength":32768,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"enrollmentId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/identity/mfa/credentials":{"get":{"summary":"List the signed-in user's MFA credentials","tags":["identity"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/identity/mfa/verification-options":{"post":{"summary":"List the signed-in user's factors and start a WebAuthn step-up ceremony","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["action"],"properties":{"action":{"minLength":1,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/identity/mfa/credentials/{credentialId}":{"delete":{"summary":"Revoke one MFA credential","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"credentialId","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/identity/mfa/recovery-codes/rotate":{"post":{"summary":"Replace recovery codes and return the new codes once","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."}},"/v1/accounts/{AC}/identity/users/{userSid}/mfa/reset":{"post":{"summary":"Reset all MFA factors for a user","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^US[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"userSid","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/identity/users/{userSid}/sessions/revoke-all":{"post":{"summary":"Revoke every active browser session for a user","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^US[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"userSid","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/identity/auth-policy":{"get":{"summary":"Get organization authentication policy","tags":["identity"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write","audit:read"],"description":"Required scope: any one of `roles:write`, `audit:read`."},"put":{"summary":"Replace organization authentication policy","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["ssoEnforced","passwordLoginEnabled","mfaRequiredForAllRoles","recoveryRevokesMfa","autoDisableInactiveApiKeys","sessionIdleTimeoutMinutes","sessionAbsoluteTimeoutHours","expectedVersion","stepUpToken"],"properties":{"ssoEnforced":{"type":"boolean"},"passwordLoginEnabled":{"type":"boolean"},"mfaRequiredForAllRoles":{"type":"boolean"},"recoveryRevokesMfa":{"type":"boolean"},"autoDisableInactiveApiKeys":{"type":"boolean"},"sessionIdleTimeoutMinutes":{"minimum":15,"maximum":1440,"type":"integer"},"sessionAbsoluteTimeoutHours":{"minimum":1,"maximum":2160,"type":"integer"},"expectedVersion":{"minimum":1,"type":"integer"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/identity/providers":{"get":{"summary":"List organization identity providers","tags":["identity"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["api:access"],"description":"Required scope: `api:access`."},"post":{"summary":"Stage an identity provider configuration","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["providerKey","protocol","publicConfig","stepUpToken","reason"],"properties":{"providerKey":{"minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9_-]*$","type":"string"},"protocol":{"anyOf":[{"type":"string","enum":["OIDC"]},{"type":"string","enum":["SAML"]},{"type":"string","enum":["SCIM"]},{"type":"string","enum":["WEBAUTHN"]},{"type":"string","enum":["TOTP"]}]},"publicConfig":{"additionalProperties":true,"type":"object","properties":{}},"credentialRef":{"maxLength":512,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/identity/providers/{providerId}/activate":{"post":{"summary":"Verify and activate an identity provider","tags":["identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","reason"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"providerId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"],"description":"Required scope: `roles:write`."}},"/v1/accounts/{AC}/identity/providers/{providerId}/suspend":{"post":{"summary":"Suspend an identity provider","tags":["identity"],"description":"Deprovisioning (§10.1): the provider stops backing sign-in, MFA or SCIM at once, every browser session it authenticated is revoked, and it can be re-verified and activated later.\n\nRequired scope: `roles:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken","reason"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"},"reason":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"providerId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["roles:write"]}},"/v1/accounts/{AC}/privacy/requests":{"post":{"summary":"Create a data-subject privacy request","tags":["privacy"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["kind","subject","reason","stepUpToken"],"properties":{"kind":{"anyOf":[{"type":"string","enum":["ERASURE"]},{"type":"string","enum":["ACCESS"]},{"type":"string","enum":["PORTABILITY"]},{"type":"string","enum":["RECTIFICATION"]},{"type":"string","enum":["RESTRICTION"]}]},"subject":{"anyOf":[{"additionalProperties":false,"type":"object","required":["contactSid"],"properties":{"contactSid":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["identifier"],"properties":{"identifier":{"minLength":1,"maxLength":512,"type":"string"}}}]},"reason":{"minLength":1,"maxLength":2000,"type":"string"},"changes":{"additionalProperties":false,"type":"object","properties":{"displayName":{"anyOf":[{"type":"null"},{"maxLength":128,"type":"string"}]},"locale":{"anyOf":[{"type":"null"},{"maxLength":16,"type":"string"}]},"timezone":{"anyOf":[{"type":"null"},{"maxLength":64,"type":"string"}]},"attributes":{"type":"object","additionalProperties":{}}}},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["privacy:write"],"description":"Required scope: `privacy:write`."},"get":{"summary":"List privacy requests","tags":["privacy"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["privacy:read"],"description":"Required scope: `privacy:read`."}},"/v1/accounts/{AC}/privacy/requests/{DR}/lift-restriction":{"post":{"summary":"Lift the processing restriction a RESTRICTION request placed","tags":["privacy"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason","stepUpToken"],"properties":{"reason":{"minLength":1,"maxLength":2000,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^DR[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"DR","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["privacy:write"],"description":"Required scope: `privacy:write`."}},"/v1/accounts/{AC}/privacy/requests/{DR}":{"get":{"summary":"Get a privacy request","tags":["privacy"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"pattern":"^DR[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"DR","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["privacy:read"],"description":"Required scope: `privacy:read`."}},"/v1/accounts/{AC}/privacy/retention-policy":{"get":{"summary":"Get the account retention policy","tags":["privacy"],"description":"A null window means the data is kept until the customer deletes it, which is the default for an account that never set a policy.\n\nRequired scope: `privacy:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["privacy:read"]},"put":{"summary":"Set the account retention policy","tags":["privacy"],"description":"Content is kept 30 to 3650 days and message records 1 to 120 months; null keeps them until deleted. A change that shortens either window removes data and needs a step-up token for RETENTION_POLICY_CHANGE; the response says what the retention job will remove on its next run.\n\nRequired scope: `retention:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["messageContentDays","messageMetadataMonths"],"properties":{"messageContentDays":{"anyOf":[{"minimum":30,"maximum":3650,"type":"integer"},{"type":"null"}]},"messageMetadataMonths":{"anyOf":[{"minimum":1,"maximum":120,"type":"integer"},{"type":"null"}]},"analyticsMonths":{"minimum":1,"maximum":36,"type":"integer"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["retention:write"]}},"/v1/accounts/{AC}/privacy/retention-policy/preview":{"get":{"summary":"Preview what a retention policy would remove now","tags":["privacy"],"description":"A dry run with the retention job's own windows and legal-hold rules. Nothing is changed. Omit a window to preview keeping that data until deleted.\n\nRequired scope: `privacy:read`.","parameters":[{"schema":{"minimum":30,"maximum":3650,"type":"integer"},"in":"query","name":"messageContentDays","required":false},{"schema":{"minimum":1,"maximum":120,"type":"integer"},"in":"query","name":"messageMetadataMonths","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["privacy:read"]}},"/v1/accounts/{AC}/legal-holds":{"get":{"summary":"List standing and released legal holds","tags":["privacy"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["legal_holds:read"],"description":"Required scope: `legal_holds:read`."},"post":{"summary":"Place a legal hold","tags":["privacy"],"description":"The account's own compliance role (legal_holds:manage: OWNER, ADMIN, COMPLIANCE_MANAGER) places a hold on the account, a contact, a conversation, a campaign or a date range. While it stands, retention skips the data in scope and erasure requests that touch it are parked. ShipMsg staff holds need an approvalSid.\n\nRequired scope: any one of `legal_holds:write`, `legal_holds:manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["scope","caseRef"],"properties":{"scope":{"anyOf":[{"additionalProperties":false,"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["ACCOUNT"]}}},{"additionalProperties":false,"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["CONTACT"]},"ref":{"minLength":1,"maxLength":128,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["CONVERSATION"]},"ref":{"minLength":1,"maxLength":128,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["CAMPAIGN"]},"ref":{"minLength":1,"maxLength":128,"type":"string"}}},{"additionalProperties":false,"type":"object","required":["kind","from","to"],"properties":{"kind":{"type":"string","enum":["DATE_RANGE"]},"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}}}]},"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"customerVisible":{"type":"boolean"},"approvalSid":{"pattern":"^AP[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["legal_holds:write","legal_holds:manage"]}},"/v1/accounts/{AC}/legal-holds/{holdId}/release":{"post":{"summary":"Release a legal hold","tags":["privacy"],"description":"Releasing lets retention and parked erasures remove the data again. The account's compliance role releases only holds it placed, with a step-up token for LEGAL_HOLD_RELEASE; a hold ShipMsg placed is released only by ShipMsg compliance.\n\nRequired scope: any one of `legal_holds:write`, `legal_holds:manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["caseRef"],"properties":{"caseRef":{"minLength":1,"maxLength":128,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"holdId","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["legal_holds:write","legal_holds:manage"]}},"/v1/accounts/{AC}/media":{"get":{"summary":"List media objects and scan/retention state","tags":["media"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["object","sid","status","expiresAt","downloadUrl"],"properties":{"object":{"type":"string","enum":["media"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"status":{"type":"string"},"expiresAt":{"type":"string"},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["media:read"],"description":"Required scope: `media:read`."},"post":{"summary":"Upload or fetch media","tags":["media"],"description":"Upload a file (multipart) or have Ship Messages fetch one from a URL. Use the returned media SID in a message. Files are scanned before they can be sent.\n\nRequired scope: `media:write`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","status","expiresAt","downloadUrl"],"properties":{"object":{"type":"string","enum":["media"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"status":{"type":"string"},"expiresAt":{"type":"string"},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"media","sid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"status","expiresAt":"expiresAt","downloadUrl":"downloadUrl"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","minLength":1,"maxLength":4096},"type":{"type":"string","enum":["AUTO","IMAGE","AUDIO","VIDEO","DOCUMENT","STICKER"]},"declaredMime":{"type":"string","maxLength":255},"filename":{"type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"required":["file"],"properties":{"file":{"type":"string","format":"binary"},"declaredMime":{"type":"string","maxLength":255},"type":{"type":"string","enum":["AUTO","IMAGE","AUDIO","VIDEO","DOCUMENT","STICKER"]}}}}}},"x-required-scope":["media:write"]}},"/v1/accounts/{AC}/media/{ME}":{"get":{"summary":"Fetch media metadata","tags":["media"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"ME","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","required":["object","sid","status","expiresAt","downloadUrl"],"properties":{"object":{"type":"string","enum":["media"]},"sid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"status":{"type":"string"},"expiresAt":{"type":"string"},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"example":{"object":"media","sid":"ME01J8Z3K4M5N6P7Q8R9S0T1V2W3","status":"status","expiresAt":"expiresAt","downloadUrl":"downloadUrl"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["media:read"],"description":"Fetch a media object's type, size, scan result and expiry.\n\nRequired scope: `media:read`."},"delete":{"summary":"Delete media","tags":["media"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"ME","required":true}],"responses":{"204":{"description":"Default Response"},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["media:write"],"description":"Required scope: `media:write`."}},"/v1/accounts/{AC}/media/uploads":{"post":{"summary":"Create a template-header resumable upload","tags":["media"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["mediaSid"],"properties":{"mediaSid":{"pattern":"^ME[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["handle","mediaSid","fileOffset"],"properties":{"handle":{"pattern":"^[0-9]+:\\S+$","type":"string"},"mediaSid":{"type":"string"},"fileOffset":{"type":"integer"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["media:write"],"description":"Required scope: `media:write`."}},"/v1/accounts/{AC}/integrations/shopify":{"get":{"summary":"Read the Shopify store connection","tags":["integrations"],"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"],"description":"Required scope: `accounts:read`."},"delete":{"summary":"Disconnect Shopify","tags":["integrations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["stepUpToken"],"properties":{"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/integrations/shopify/connect":{"post":{"summary":"Start Shopify authorization","tags":["integrations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["shop","stepUpToken"],"properties":{"shop":{"maxLength":128,"type":"string"},"stepUpToken":{"minLength":32,"maxLength":256,"type":"string"}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/integrations/shopify/complete":{"post":{"summary":"Complete Shopify authorization","tags":["integrations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"type":"object","additionalProperties":{"maxLength":4096,"type":"string"}}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write"],"description":"Required scope: `accounts:write`."}},"/v1/accounts/{AC}/contacts/{CT}/shopify-orders":{"get":{"summary":"Read a contact's recent Shopify orders","tags":["integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"AC","required":true},{"schema":{"pattern":"^CT[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"CT","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["contacts:read"],"description":"Required scope: `contacts:read`."}},"/v1/accounts/{AC}/audit":{"get":{"summary":"List tamper-evident audit entries for the account","tags":["audit"],"description":"Entries are masked by default (§50). `unmask=true` requires contacts:read_identifiers and records a RESTRICTED_DATA_READ entry of its own (§51).\n\nRequired scope: `audit:read`.","parameters":[{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"query","name":"action","required":false},{"schema":{"minLength":1,"maxLength":256,"type":"string"},"in":"query","name":"actorRef","required":false},{"schema":{"minLength":1,"maxLength":256,"type":"string"},"in":"query","name":"resourceRef","required":false,"description":"Entries about this resource, including read-access entries that exposed it (a contact's messages, a conversation's thread)."},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"since","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"until","required":false},{"schema":{"type":"boolean"},"in":"query","name":"unmask","required":false},{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor","dataAsOf"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","id","occurredAt","action","actor","onBehalfOf","resourceRef","reason","caseRef","approvalId","requestId","correlationId","ipAddress","data","prevHash","entryHash","masked","livemode"],"properties":{"object":{"type":"string","enum":["audit_entry"]},"id":{"format":"uuid","type":"string"},"occurredAt":{"format":"date-time","type":"string"},"action":{"type":"string"},"actor":{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string"},"ref":{"type":"string"}}},"onBehalfOf":{"anyOf":[{"type":"string"},{"type":"null"}]},"resourceRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"caseRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"approvalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requestId":{"anyOf":[{"type":"string"},{"type":"null"}]},"correlationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{},"prevHash":{"anyOf":[{"type":"string"},{"type":"null"}]},"entryHash":{"type":"string"},"masked":{"type":"boolean"},"livemode":{"type":"boolean"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["audit:read"]}},"/v1/accounts/{AC}/audit/chain-head":{"get":{"summary":"Current tamper-evidence chain head for the account","tags":["audit"],"description":"The head hash an auditor compares against the hourly Object-Locked export anchor (§51.1).\n\nRequired scope: `audit:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","entryCount","entryHash","lastEntryId","lastEntryAt","dataAsOf"],"properties":{"object":{"type":"string","enum":["audit_chain_head"]},"entryCount":{"type":"integer"},"entryHash":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastEntryId":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}]},"lastEntryAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"dataAsOf":{"format":"date-time","type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["audit:read"]}},"/v1/changelog":{"get":{"summary":"Public API changelog feed (§68)","tags":["accounts"],"description":"Every known API date version with its release, deprecation and end-of-support dates, newest first. The same entries are published as RSS 2.0 at `/v1/changelog.rss`.","parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false}],"security":[],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["object","title","homeUrl","data","hasMore","nextCursor","dataAsOf"],"properties":{"object":{"type":"string","enum":["changelog"]},"title":{"type":"string"},"homeUrl":{"type":"string"},"data":{"type":"array","items":{"type":"object","required":["object","version","title","status","summary","url","releasedOn","deprecatedOn","sunsetOn","publishedAt"],"properties":{"object":{"type":"string","enum":["changelog_entry"]},"version":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"summary":{"type":"string"},"url":{"type":"string"},"releasedOn":{"type":"string"},"deprecatedOn":{"anyOf":[{"type":"string"},{"type":"null"}]},"sunsetOn":{"anyOf":[{"type":"string"},{"type":"null"}]},"publishedAt":{"type":"string"}}}},"hasMore":{"type":"boolean"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataAsOf":{"type":"string"}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/changelog.rss":{"get":{"summary":"Public API changelog feed as RSS 2.0 (§68)","tags":["accounts"],"security":[],"responses":{"200":{"description":"RSS 2.0 document","content":{"application/rss+xml":{"schema":{"description":"RSS 2.0 document","type":"string"}}}},"400":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/rss+xml":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}}}},"/v1/accounts/{AC}/api-versions":{"get":{"summary":"List API date versions and the account default","tags":["accounts"],"description":"The §68 version registry: known dates, their status and their end-of-support dates, together with this account's default and the version this request resolved to.\n\nRequired scope: `accounts:read`.","parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","accountDefault","platformDefault","effective"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["object","version","status","releasedOn","changelogUrl","summary"],"properties":{"object":{"type":"string","enum":["api_version"]},"version":{"type":"string"},"status":{"type":"string"},"releasedOn":{"type":"string"},"changelogUrl":{"type":"string"},"summary":{"type":"string"}}}},"accountDefault":{"anyOf":[{"type":"string"},{"type":"null"}]},"platformDefault":{"type":"string"},"effective":{"type":"object","required":["version","source"],"properties":{"version":{"type":"string"},"source":{"type":"string"}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:read"]}},"/v1/accounts/{AC}/api-versions/default":{"patch":{"summary":"Set the account default API version","tags":["accounts"],"description":"§68: the per-account default a request without `ShipMessages-Version` resolves to. `null` restores the platform default. A sunset or unknown date is refused.\n\nRequired scope: any one of `accounts:write`, `api_keys:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["version"],"properties":{"version":{"anyOf":[{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},{"type":"null"}]}}}}}},"parameters":[{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},"in":"header","name":"idempotency-key","required":true,"description":"Required for every external API mutation (§15, §142 rule 32)"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["data","accountDefault","platformDefault","effective"],"properties":{"data":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["object","version","status","releasedOn","changelogUrl","summary"],"properties":{"object":{"type":"string","enum":["api_version"]},"version":{"type":"string"},"status":{"type":"string"},"releasedOn":{"type":"string"},"changelogUrl":{"type":"string"},"summary":{"type":"string"}}}},"accountDefault":{"anyOf":[{"type":"string"},{"type":"null"}]},"platformDefault":{"type":"string"},"effective":{"type":"object","required":["version","source"],"properties":{"version":{"type":"string"},"source":{"type":"string"}}}}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["accounts:write","api_keys:write"]}},"/v1/accounts/{AC}/request-logs":{"get":{"summary":"List privacy-safe retained API request facts","tags":["developer"],"parameters":[{"schema":{"minimum":1,"maximum":100,"type":"integer"},"in":"query","name":"limit","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"occurredAfter","required":false},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"occurredBefore","required":false},{"schema":{"maxLength":8,"type":"string"},"in":"query","name":"method","required":false},{"schema":{"maxLength":128,"type":"string"},"in":"query","name":"route","required":false},{"schema":{"minimum":100,"maximum":599,"type":"integer"},"in":"query","name":"status","required":false},{"schema":{"anyOf":[{"type":"string","enum":["2xx"]},{"type":"string","enum":["3xx"]},{"type":"string","enum":["4xx"]},{"type":"string","enum":["5xx"]}]},"in":"query","name":"statusClass","required":false},{"schema":{"maxLength":128,"type":"string"},"in":"query","name":"requestId","required":false},{"schema":{"maxLength":128,"type":"string"},"in":"query","name":"resource","required":false},{"schema":{"pattern":"^SM[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"messageSid","required":false},{"schema":{"pattern":"^WA[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"senderSid","required":false},{"schema":{"pattern":"^SK[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"keySid","required":false},{"schema":{"pattern":"^(US|SK)[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"query","name":"principalRef","required":false},{"schema":{"pattern":"^[A-Z][A-Z0-9_]{1,63}$","type":"string"},"in":"query","name":"errorCode","required":false},{"schema":{"pattern":"^AC[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"in":"path","name":"AC","required":true,"description":"Account SID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"401":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"403":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"404":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"409":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"422":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"429":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"500":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}},"503":{"description":"§13A.9 error envelope","content":{"application/json":{"schema":{"description":"§13A.9 error envelope","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","type","message","retryable","retryAfterSeconds","docUrl"],"properties":{"code":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfterSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}]},"docUrl":{"type":"string"},"requestId":{"type":"string"},"providerCode":{"type":"integer"},"details":{"type":"array","items":{"type":"object","required":["path","issue"],"properties":{"path":{"type":"string"},"issue":{"type":"string"}}}}}}}}}}}},"x-required-scope":["usage:read","events:read"],"description":"Required scope: any one of `usage:read`, `events:read`."}},"/scim/v2/{endpointKey}/ServiceProviderConfig":{"get":{"summary":"Get SCIM service-provider configuration","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"/scim/v2/{endpointKey}/Schemas":{"get":{"summary":"List supported SCIM schemas","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"/scim/v2/{endpointKey}/Schemas/{schemaId}":{"get":{"summary":"Get one supported SCIM schema","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"minLength":1,"maxLength":256,"type":"string"},"in":"path","name":"schemaId","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"/scim/v2/{endpointKey}/ResourceTypes":{"get":{"summary":"List supported SCIM resource types","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"/scim/v2/{endpointKey}/ResourceTypes/{resourceTypeId}":{"get":{"summary":"Get one supported SCIM resource type","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["User"]},{"type":"string","enum":["Group"]}]},"in":"path","name":"resourceTypeId","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"/scim/v2/{endpointKey}/{resourceType}":{"get":{"summary":"List SCIM Users or Groups. Dual pagination (§109.1): RFC 7644 startIndex/count for SCIM compliance, or the platform keyset cursor/count; every page carries nextCursor (null on the last page) so a client may continue by cursor from either mode. startIndex and cursor are mutually exclusive.","tags":["scim"],"parameters":[{"schema":{"minimum":1,"maximum":1000000,"type":"integer"},"in":"query","name":"startIndex","required":false},{"schema":{"minimum":0,"maximum":100,"type":"integer"},"in":"query","name":"count","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"cursor","required":false},{"schema":{"minLength":1,"maxLength":2048,"type":"string"},"in":"query","name":"filter","required":false},{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["Users"]},{"type":"string","enum":["Groups"]}]},"in":"path","name":"resourceType","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"post":{"summary":"Create a SCIM User or Group","tags":["scim"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["Users"]},{"type":"string","enum":["Groups"]}]},"in":"path","name":"resourceType","required":true},{"schema":{"minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$","type":"string"},"in":"header","name":"idempotency-key","required":true}],"security":[{"scimToken":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"412":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"428":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}},"/scim/v2/{endpointKey}/{resourceType}/{id}":{"get":{"summary":"Get one SCIM User or Group","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["Users"]},{"type":"string","enum":["Groups"]}]},"in":"path","name":"resourceType","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"put":{"summary":"Replace a SCIM User or Group","tags":["scim"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["Users"]},{"type":"string","enum":["Groups"]}]},"in":"path","name":"resourceType","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true},{"schema":{"minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$","type":"string"},"in":"header","name":"idempotency-key","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"412":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"428":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"patch":{"summary":"Patch a SCIM User or Group","tags":["scim"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["Users"]},{"type":"string","enum":["Groups"]}]},"in":"path","name":"resourceType","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true},{"schema":{"minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$","type":"string"},"in":"header","name":"idempotency-key","required":true}],"security":[{"scimToken":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"412":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"428":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}},"delete":{"summary":"Delete a SCIM User or Group","tags":["scim"],"parameters":[{"schema":{"pattern":"^[0-9a-f]{48}$","type":"string"},"in":"path","name":"endpointKey","required":true},{"schema":{"anyOf":[{"type":"string","enum":["Users"]},{"type":"string","enum":["Groups"]}]},"in":"path","name":"resourceType","required":true},{"schema":{"format":"uuid","type":"string"},"in":"path","name":"id","required":true},{"schema":{"minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$","type":"string"},"in":"header","name":"idempotency-key","required":true}],"security":[{"scimToken":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"412":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"428":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","properties":{}}}}}}}}},"servers":[{"url":"https://api.shipmsg.com"}],"security":[{"apiKey":[]}]}