{"items":[{"type":"link","label":"Provisioning API","link":"/docs/provisioning-api/api-reference/provisioning-api","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api","content":{"contentType":"overview","meta":{"name":"Provisioning API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"provisioning-api.json","url":"/_bundle/docs/provisioning-api/api-reference/provisioning-api.json?download"},{"kind":"download","label":"provisioning-api.yaml","url":"/_bundle/docs/provisioning-api/api-reference/provisioning-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Provisioning API (1.2.118)","showPageActions":true}],"sectionId":"/docs/provisioning-api/api-reference/provisioning-api"}]}]}},{"type":"separator","label":"Webhook","content":null},{"type":"group","label":"Webhooks","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks","items":[{"label":"List all webhooks in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_listwebhooks_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_listwebhooks_v1","metadata":{"seo":{"title":"List all webhooks in project","description":"Returns a paginated list of webhooks for the specified project. If no page token is supplied then all registered webhooks (of maximum 15) are returned in alphabetical order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookWebhookController_listWebhooks_v1","name":"List all webhooks in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all webhooks in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of webhooks for the specified project. If no page token is supplied then all registered webhooks (of maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are returned in alphabetical order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_923","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/webhooks","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_923"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/projects/{projectId}/webhooks","href":"webhooks/webhookwebhookcontroller_listwebhooks_v1","openApiOperationId":"WebhookWebhookController_listWebhooks_v1","summary":"List all webhooks in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of webhooks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/200/content/application~1json/examples/listWebhooksRes"]}},"schemaId":"components/schemas/WebhookWebhookListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/200/content/application~1json/examples/listWebhooksRes"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_size-0","paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_token-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_size-0","paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_token-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookWebhookListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/200/content/application~1json/examples/listWebhooksRes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/200/content/application~1json/examples/listWebhooksRes"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_size-0","paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_token-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_size-0","paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_token-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookwebhookcontroller_listwebhooks_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/webhooks"},{"label":"Register a webhook for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_createwebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_createwebhook_v1","metadata":{"seo":{"title":"Register a webhook for project","description":"Register a new webhook for a project. The webhook will be used to communicate updates to resources. Maximum of 15 webhooks allowed per project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookWebhookController_createWebhook_v1","name":"Register a webhook for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a webhook for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a new webhook for a project. The webhook will be used to communicate updates to resources. Maximum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhooks allowed per project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq","paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq"]}},"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq","paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq"],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody","description":"Webhook to register"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/webhooks","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq","paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq"]}},"responseCodes":["201","400","401","409","424","500"],"pointer":"/v1/projects/{projectId}/webhooks","href":"webhooks/webhookwebhookcontroller_createwebhook_v1","openApiOperationId":"WebhookWebhookController_createWebhook_v1","summary":"Register a webhook for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq","paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq","paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookNoTriggerRes","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookRes"]}},"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookNoTriggerRes","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookRes"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_payload-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_payload-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/409/content/application~1json/examples/webhook_exists-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/409/content/application~1json/examples/webhook_exists-0"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookNoTriggerRes","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookRes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookNoTriggerRes","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookRes"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_payload-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_payload-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/409/content/application~1json/examples/webhook_exists-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/409/content/application~1json/examples/webhook_exists-0"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookwebhookcontroller_createwebhook_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/webhooks"},{"label":"Get webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_getwebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_getwebhook_v1","metadata":{"seo":{"title":"Get webhook","description":"Return an already created webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookWebhookController_getWebhook_v1","name":"Get webhook","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webhook","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Return an already created webhook.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"webhookId","in":"path","schemaId":"schema_922","description":"The unique ID of the webhook.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/webhooks/{webhookId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/webhooks/{webhookId}","href":"webhooks/webhookwebhookcontroller_getwebhook_v1","openApiOperationId":"WebhookWebhookController_getWebhook_v1","summary":"Get webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/triggers","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/noTriggers"]}},"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/triggers","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/noTriggers"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/404/content/application~1json/examples/webhook_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/404/content/application~1json/examples/webhook_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/triggers","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/noTriggers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/triggers","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/noTriggers"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/404/content/application~1json/examples/webhook_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/404/content/application~1json/examples/webhook_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookwebhookcontroller_getwebhook_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/webhooks/{webhookId}"},{"label":"Delete webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_deletewebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_deletewebhook_v1","metadata":{"seo":{"title":"Delete webhook","description":"Deletes an already created webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookWebhookController_deleteWebhook_v1","name":"Delete webhook","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webhook","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Deletes an already created webhook.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"webhookId","in":"path","schemaId":"schema_922","description":"The unique ID of the webhook.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/webhooks/{webhookId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","500"],"pointer":"/v1/projects/{projectId}/webhooks/{webhookId}","href":"webhooks/webhookwebhookcontroller_deletewebhook_v1","openApiOperationId":"WebhookWebhookController_deleteWebhook_v1","summary":"Delete webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Webhook deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/examples/webhook_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/examples/webhook_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/examples/webhook_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/examples/webhook_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookwebhookcontroller_deletewebhook_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/webhooks/{webhookId}"},{"label":"Replace webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_replacewebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_replacewebhook_v1","metadata":{"seo":{"title":"Replace webhook","description":"Replace an already existing webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookWebhookController_replaceWebhook_v1","name":"Replace webhook","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace webhook","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Replace an already existing webhook.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"webhookId","in":"path","schemaId":"schema_922","description":"The unique ID of the webhook.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"]}},"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody","description":"Webhook to replace"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/projects/{projectId}/webhooks/{webhookId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/webhooks/{webhookId}","href":"webhooks/webhookwebhookcontroller_replacewebhook_v1","openApiOperationId":"WebhookWebhookController_replaceWebhook_v1","summary":"Replace webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"]}},"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_id_format-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_id_format-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/404/content/application~1json/examples/webhook_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/404/content/application~1json/examples/webhook_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/409/content/application~1json/examples/webhook_exists-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/409/content/application~1json/examples/webhook_exists-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_id_format-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_id_format-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/404/content/application~1json/examples/webhook_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/404/content/application~1json/examples/webhook_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/409/content/application~1json/examples/webhook_exists-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/409/content/application~1json/examples/webhook_exists-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookwebhookcontroller_replacewebhook_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/webhooks/{webhookId}"},{"label":"Update webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_updatewebhook_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/webhooks/webhookwebhookcontroller_updatewebhook_v1","metadata":{"seo":{"title":"Update webhook","description":"Update an already existing webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WebhookWebhookController_updateWebhook_v1","name":"Update webhook","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update webhook","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Update an already existing webhook.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"webhookId","in":"path","schemaId":"schema_922","description":"The unique ID of the webhook.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookUpdateWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"]}},"schemaId":"components/schemas/WebhookUpdateWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody","description":"Webhook to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/webhooks/{webhookId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"webhookId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookUpdateWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/webhooks/{webhookId}","href":"webhooks/webhookwebhookcontroller_updatewebhook_v1","openApiOperationId":"WebhookWebhookController_updateWebhook_v1","summary":"Update webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WebhookUpdateWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookUpdateWebhookInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"]}},"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_id_format-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_id_format-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/examples/webhook_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/examples/webhook_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/409/content/application~1json/examples/webhook_exists-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/409/content/application~1json/examples/webhook_exists-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookWebhookDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookRes","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_id_format-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_id_format-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/examples/webhook_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/examples/webhook_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/409/content/application~1json/examples/webhook_exists-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/409/content/application~1json/examples/webhook_exists-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookwebhookcontroller_updatewebhook_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/webhooks/{webhookId}"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks allow the Sinch servers to communicate with your server backend. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint lets you create, update, and delete webhooks programmatically."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/webhooks","summary":"List all webhooks in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/webhooks/webhookwebhookcontroller_listwebhooks_v1","deprecated":false},{"title":"/v1/projects/{projectId}/webhooks","summary":"Register a webhook for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/webhooks/webhookwebhookcontroller_createwebhook_v1","deprecated":false},{"title":"/v1/projects/{projectId}/webhooks/{webhookId}","summary":"Get webhook","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/webhooks/webhookwebhookcontroller_getwebhook_v1","deprecated":false},{"title":"/v1/projects/{projectId}/webhooks/{webhookId}","summary":"Delete webhook","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/webhooks/webhookwebhookcontroller_deletewebhook_v1","deprecated":false},{"title":"/v1/projects/{projectId}/webhooks/{webhookId}","summary":"Replace webhook","prefix":{"name":"put","color":"put"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/webhooks/webhookwebhookcontroller_replacewebhook_v1","deprecated":false},{"title":"/v1/projects/{projectId}/webhooks/{webhookId}","summary":"Update webhook","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/webhooks/webhookwebhookcontroller_updatewebhook_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"WhatsApp","content":null},{"type":"group","label":"WhatsApp Accounts","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts","items":[{"label":"Get account for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_getaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_getaccount_v1","metadata":{"seo":{"title":"Get account for project","description":"Returns an account for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappAccountsController_getAccount_v1","name":"Get account for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns an account for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp","href":"whatsapp-accounts/whatsappaccountscontroller_getaccount_v1","openApiOperationId":"WhatsappAccountsController_getAccount_v1","summary":"Get account for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/200/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/404/content/application~1json/examples/account_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/404/content/application~1json/examples/account_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/409/content/application~1json/examples/account_data_is_corrupt-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/409/content/application~1json/examples/account_data_is_corrupt-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/404/content/application~1json/examples/account_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/404/content/application~1json/examples/account_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/409/content/application~1json/examples/account_data_is_corrupt-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/409/content/application~1json/examples/account_data_is_corrupt-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/whatsappaccountscontroller_getaccount_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp"},{"label":"Create account for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_createaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_createaccount_v1","metadata":{"seo":{"title":"Create account for project","description":"Create the WhatsApp account for the project. Each project can only have one account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappAccountsController_createAccount_v1","name":"Create account for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create account for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Create the WhatsApp account for the project. Each project can only have one account.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_924","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated"]}},"schemaId":"schema_924","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody","description":"Account data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_924","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated"]}},"responseCodes":["201","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp","href":"whatsapp-accounts/whatsappaccountscontroller_createaccount_v1","openApiOperationId":"WhatsappAccountsController_createAccount_v1","summary":"Create account for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"schema_924","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_924","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/pending","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/onboarded"]}},"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/pending","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/onboarded"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-1","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_payload-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-1","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_payload-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/404/content/application~1json/examples/project_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/404/content/application~1json/examples/project_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_data_is_corrupt-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_data_is_corrupt-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/pending","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/onboarded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/pending","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/onboarded"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-1","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_payload-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-1","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_payload-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/404/content/application~1json/examples/project_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/404/content/application~1json/examples/project_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_data_is_corrupt-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_data_is_corrupt-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Comment on account","description":"\n        Received when a comment has been added to the account.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_928","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_928","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_928","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Account onboarded","description":"\n        Received when an Account is onboarded.\n        ","callbackName":"Onboard","callbackId":"Onboard/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_929","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_929","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Onboard/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_929","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Account rejected","description":"\n        Received when an Account is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_930","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_930","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_930","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Account pending verification","description":"\n        Received when an Account is in pending verification.\n        ","callbackName":"PendingVerification","callbackId":"PendingVerification/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_931","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_931","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"PendingVerification/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_931","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Account daily limit changed","description":"\n        Received when Account daily limit has been changed by Meta.\n        ","callbackName":"BusinessDailyLimitChanged","callbackId":"BusinessDailyLimitChanged/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_932","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_932","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"BusinessDailyLimitChanged/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_932","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Account business information changed","description":"\n        Received when Account has some of its business information changed by Meta.\n        ","callbackName":"WabaInformationChanged","callbackId":"WabaInformationChanged/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_933","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_933","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"WabaInformationChanged/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_933","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/whatsappaccountscontroller_createaccount_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp"},{"label":"Delete account for project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_deleteaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_deleteaccount_v1","metadata":{"seo":{"title":"Delete account for project","description":"Deletes the account for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappAccountsController_deleteAccount_v1","name":"Delete account for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete account for project","badges":[{"name":"Closed Beta","color":"red","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Deletes the account for a project.\n\n    Deleting an account is only possible if there is no sender assigned to the account.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/whatsapp","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp","href":"whatsapp-accounts/whatsappaccountscontroller_deleteaccount_v1","openApiOperationId":"WhatsappAccountsController_deleteAccount_v1","summary":"Delete account for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Account deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_senders-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_sender_changes-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_senders-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_sender_changes-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/template_could_not_delete_drafts-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/internal_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/template_could_not_delete_drafts-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/internal_error-1"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_senders-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_sender_changes-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_senders-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_sender_changes-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/template_could_not_delete_drafts-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/internal_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/template_could_not_delete_drafts-0","paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/internal_error-1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/whatsappaccountscontroller_deleteaccount_v1"}],"panels":[]}]},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp"},{"label":"Update account for project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_updateaccount_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_updateaccount_v1","metadata":{"seo":{"title":"Update account for project","description":"Update an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappAccountsController_updateAccount_v1","name":"Update account for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is only possible to update an account that has been rejected. After update the status will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappInputUpdateAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated"]}},"schemaId":"components/schemas/WhatsappInputUpdateAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody","description":"Supported account fields to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/whatsapp","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappInputUpdateAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp","href":"whatsapp-accounts/whatsappaccountscontroller_updateaccount_v1","openApiOperationId":"WhatsappAccountsController_updateAccount_v1","summary":"Update account for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappInputUpdateAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappInputUpdateAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-1","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-1","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/404/content/application~1json/examples/account_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/404/content/application~1json/examples/account_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/409/content/application~1json/examples/account_not_updatable-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/409/content/application~1json/examples/account_not_updatable-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-1","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-1","paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/404/content/application~1json/examples/account_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/404/content/application~1json/examples/account_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/409/content/application~1json/examples/account_not_updatable-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/409/content/application~1json/examples/account_not_updatable-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/whatsappaccountscontroller_updateaccount_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp"},{"label":"Lists activities on account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on account","description":"Lists activities on account from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappAccountsController_listActivities_v1","name":"Lists activities on account","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on account","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Lists activities on account from the most recent one to the oldest one.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/activities","href":"whatsapp-accounts/whatsappaccountscontroller_listactivities_v1","openApiOperationId":"WhatsappAccountsController_listActivities_v1","summary":"Lists activities on account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/whatsappaccountscontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/activities"},{"label":"Creates a comment for an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-accounts/whatsappaccountscontroller_createcomment_v1","metadata":{"seo":{"title":"Creates a comment for an account","description":"Creates a comment for an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappAccountsController_createComment_v1","name":"Creates a comment for an account","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for an account","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for an account.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/comments","href":"whatsapp-accounts/whatsappaccountscontroller_createcomment_v1","openApiOperationId":"WhatsappAccountsController_createComment_v1","summary":"Creates a comment for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for an account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-accounts/whatsappaccountscontroller_createcomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/comments"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Accounts","showPageActions":true},{"nodeType":"markdoc","content":"The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/whatsapp","summary":"Get account for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-accounts/whatsappaccountscontroller_getaccount_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp","summary":"Create account for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-accounts/whatsappaccountscontroller_createaccount_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp","summary":"Delete account for project","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"link":"/whatsapp-accounts/whatsappaccountscontroller_deleteaccount_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp","summary":"Update account for project","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-accounts/whatsappaccountscontroller_updateaccount_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/activities","summary":"Lists activities on account","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-accounts/whatsappaccountscontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/comments","summary":"Creates a comment for an account","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-accounts/whatsappaccountscontroller_createcomment_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp","items":[{"label":"Enable Meta template analytics","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp/whatsapptemplateanalyticshelperscontroller_enabletemplateanalytics_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp/whatsapptemplateanalyticshelperscontroller_enabletemplateanalytics_v1","metadata":{"seo":{"title":"Enable Meta template analytics","description":"Enable Meta template analytics for WhatsApp Business Account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplateAnalyticsHelpersController_enableTemplateAnalytics_v1","name":"Enable Meta template analytics","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable Meta template analytics","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n      Enable Meta template analytics for WhatsApp Business Account.\n      "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/projects/{projectId}/whatsapp/enableTemplateAnalytics","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","424","500"],"pointer":"/v1/projects/{projectId}/whatsapp/enableTemplateAnalytics","href":"whatsapp/whatsapptemplateanalyticshelperscontroller_enabletemplateanalytics_v1","openApiOperationId":"WhatsappTemplateAnalyticsHelpersController_enableTemplateAnalytics_v1","summary":"Enable Meta template analytics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Meta template analytics enabled for WhatsApp Business Account."},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/424/content/application~1json/examples/template_insights_not_yet_available-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/424/content/application~1json/examples/template_insights_not_yet_available-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/424/content/application~1json/examples/template_insights_not_yet_available-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/424/content/application~1json/examples/template_insights_not_yet_available-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/whatsapptemplateanalyticshelperscontroller_enabletemplateanalytics_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/enableTemplateAnalytics"},{"label":"Create a long lived access token","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp/whatsappembeddedsignuphelpercontroller_createlonglivedaccesstoken_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp/whatsappembeddedsignuphelpercontroller_createlonglivedaccesstoken_v1","metadata":{"seo":{"title":"Create a long lived access token","description":"Returns a long lived access token based on the facebook token from the embedded signup. Valid for 60 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappEmbeddedSignupHelperController_createLongLivedAccessToken_v1","name":"Create a long lived access token","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a long lived access token","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a long lived access token based on the facebook token from the embedded signup. Valid for 60 days.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappLongLivedAccessTokenInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken"]}},"schemaId":"components/schemas/WhatsappLongLivedAccessTokenInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody","description":"Facebook token generated from the embedded signup process, or another long lived access token."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/longLivedAccessToken","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappLongLivedAccessTokenInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken"]}},"responseCodes":["201","400","401","500"],"pointer":"/v1/projects/{projectId}/whatsapp/longLivedAccessToken","href":"whatsapp/whatsappembeddedsignuphelpercontroller_createlonglivedaccesstoken_v1","openApiOperationId":"WhatsappEmbeddedSignupHelperController_createLongLivedAccessToken_v1","summary":"Create a long lived access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappLongLivedAccessTokenInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappLongLivedAccessTokenInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The long lived access token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappLongLivedAccessTokenDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappLongLivedAccessTokenDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_token-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_code-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_payload-7"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_token-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_code-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_payload-7"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/internal_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/internal_error-2"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappLongLivedAccessTokenDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappLongLivedAccessTokenDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_token-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_code-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_payload-7"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_token-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_code-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_payload-7"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/internal_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/internal_error-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/whatsappembeddedsignuphelpercontroller_createlonglivedaccesstoken_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/longLivedAccessToken"},{"label":"List WhatsApp Business Accounts details","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp/whatsappembeddedsignuphelpercontroller_listwabadetailsfortoken_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp/whatsappembeddedsignuphelpercontroller_listwabadetailsfortoken_v1","metadata":{"seo":{"title":"List WhatsApp Business Accounts details","description":"Returns a list of all the WhatsApp Business Accounts that the facebook token is associated with, together with the numbers that are shared."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappEmbeddedSignupHelperController_listWabaDetailsForToken_v1","name":"List WhatsApp Business Accounts details","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List WhatsApp Business Accounts details","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a list of all the WhatsApp Business Accounts that the facebook token is associated with, together with the numbers that are shared.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappWabaDetailsListInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappWabaDetailsListInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody","description":"WabaDetails data with Facebook token generated from the embedded signup process."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/wabaDetails","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappWabaDetailsListInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["200","400","401","500"],"pointer":"/v1/projects/{projectId}/whatsapp/wabaDetails","href":"whatsapp/whatsappembeddedsignuphelpercontroller_listwabadetailsfortoken_v1","openApiOperationId":"WhatsappEmbeddedSignupHelperController_listWabaDetailsForToken_v1","summary":"List WhatsApp Business Accounts details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappWabaDetailsListInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappWabaDetailsListInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of WhatsApp Business Accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappWabaDetailsListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappWabaDetailsListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_facebook_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_payload-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_facebook_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_payload-4"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/internal_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/internal_error-2"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappWabaDetailsListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappWabaDetailsListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_facebook_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_payload-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_facebook_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_payload-4"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/internal_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/internal_error-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp/whatsappembeddedsignuphelpercontroller_listwabadetailsfortoken_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/wabaDetails"}],"content":{"contentType":"group","meta":{"name":"WhatsApp"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp","showPageActions":true},{"nodeType":"markdoc","content":"The WhatsApp endpoint enables programmatic login to your WhatsApp account and retrieval of its details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/whatsapp/enableTemplateAnalytics","summary":"Enable Meta template analytics","prefix":{"name":"put","color":"put"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp/whatsapptemplateanalyticshelperscontroller_enabletemplateanalytics_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/longLivedAccessToken","summary":"Create a long lived access token","prefix":{"name":"post","color":"http-deprecated"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp/whatsappembeddedsignuphelpercontroller_createlonglivedaccesstoken_v1","deprecated":true},{"title":"/v1/projects/{projectId}/whatsapp/wabaDetails","summary":"List WhatsApp Business Accounts details","prefix":{"name":"post","color":"http-deprecated"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp/whatsappembeddedsignuphelpercontroller_listwabadetailsfortoken_v1","deprecated":true}]}]}]}]}},{"type":"group","label":"WhatsApp Flows","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows","items":[{"label":"Get flows in the WhatsApp business account (WABA) associated to the project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows/whatsappflowscontroller_listflows_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows/whatsappflowscontroller_listflows_v1","metadata":{"seo":{"title":"Get flows in the WhatsApp business account (WABA) associated to the project","description":"Retrieve the list of flows created in the WhatsApp business account (WABA) associated with the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappFlowsController_listFlows_v1","name":"Get flows in the WhatsApp business account (WABA) associated to the project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get flows in the WhatsApp business account (WABA) associated to the project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Retrieve the list of flows created in the WhatsApp business account (WABA) associated with the project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/flows","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/flows","href":"whatsapp-flows/whatsappflowscontroller_listflows_v1","openApiOperationId":"WhatsappFlowsController_listFlows_v1","summary":"Get flows in the WhatsApp business account (WABA) associated to the project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Flows","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappFlowListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappFlowListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/404/content/application~1json/examples/project_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/404/content/application~1json/examples/project_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappFlowListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappFlowListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/404/content/application~1json/examples/project_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/404/content/application~1json/examples/project_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-flows/whatsappflowscontroller_listflows_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/flows"},{"label":"Get screens of a flow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows/whatsappflowscontroller_listflowscreens_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-flows/whatsappflowscontroller_listflowscreens_v1","metadata":{"seo":{"title":"Get screens of a flow","description":"Retrieve the list of screens in a flow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappFlowsController_listFlowScreens_v1","name":"Get screens of a flow","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get screens of a flow","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Retrieve the list of screens in a flow.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"flowId","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/flows/{flowId}/screens","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"flowId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/flows/{flowId}/screens","href":"whatsapp-flows/whatsappflowscontroller_listflowscreens_v1","openApiOperationId":"WhatsappFlowsController_listFlowScreens_v1","summary":"Get screens of a flow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Flow screens","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappFlowScreenListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappFlowScreenListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_not_found-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_screens_not_found-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_not_found-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_screens_not_found-2"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappFlowScreenListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappFlowScreenListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_not_found-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_screens_not_found-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_not_found-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_screens_not_found-2"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-flows/whatsappflowscontroller_listflowscreens_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/flows/{flowId}/screens"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Flows"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Flows","showPageActions":true},{"nodeType":"markdoc","content":"The WhatsApp flows endpoint lets you retrieve and manage WhatsApp Flows associated with the project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/whatsapp/flows","summary":"Get flows in the WhatsApp business account (WABA) associated to the project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-flows/whatsappflowscontroller_listflows_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/flows/{flowId}/screens","summary":"Get screens of a flow","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-flows/whatsappflowscontroller_listflowscreens_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Senders","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders","items":[{"label":"List all senders in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_listsenders_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_listsenders_v1","metadata":{"seo":{"title":"List all senders in project","description":"Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_listSenders_v1","name":"List all senders in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all senders in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of senders for the specified project. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"filterStates","in":"query","schemaId":"schema_935","description":"Optionally query for sender by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_936","description":"Optionally query for sender by statuses."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_935"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_936"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders","href":"whatsapp-senders/whatsappsenderscontroller_listsenders_v1","openApiOperationId":"WhatsappSendersController_listSenders_v1","summary":"List all senders in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of senders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_listsenders_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders"},{"label":"Create sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_createsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_createsender_v1","metadata":{"seo":{"title":"Create sender for project","description":"Creates a sender for a project. The possible combinations of region, business manager and hosting type are the following"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_createSender_v1","name":"Create sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a sender for a project. The possible combinations of region, business manager and hosting type are the following"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINCH_BR"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINCH_MX"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINCH_UK"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded (ES)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Unsupported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner-initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Unsupported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded (ES)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Unsupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Unsupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner-initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Unsupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Unsupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded (ES)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner-initiated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Supported"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_937","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode"]}},"schemaId":"schema_937","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody","description":"Sender data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_937","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode"]}},"responseCodes":["201","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders","href":"whatsapp-senders/whatsappsenderscontroller_createsender_v1","openApiOperationId":"WhatsappSendersController_createSender_v1","summary":"Create sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"schema_937","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_937","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_facebook_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_payload-6"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_facebook_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_payload-6"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_waba_id-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/not_found_waba_id-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/too_many_waba_id-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/waba_id_used-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/used_phone_number_id-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/provisioned_phone_number_id-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/all_phone_number_id_provisioned-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/invalid_waba_id_or_phone_number_id_for_region-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_not_found-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-12","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-13"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_waba_id-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/not_found_waba_id-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/too_many_waba_id-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/waba_id_used-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/used_phone_number_id-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/provisioned_phone_number_id-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/all_phone_number_id_provisioned-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/invalid_waba_id_or_phone_number_id_for_region-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_not_found-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-12","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-13"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/internal_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/internal_error-2"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_facebook_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_payload-6"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_facebook_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_payload-6"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_waba_id-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/not_found_waba_id-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/too_many_waba_id-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/waba_id_used-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/used_phone_number_id-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/provisioned_phone_number_id-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/all_phone_number_id_provisioned-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/invalid_waba_id_or_phone_number_id_for_region-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_not_found-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-12","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-13"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_waba_id-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/not_found_waba_id-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/too_many_waba_id-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/waba_id_used-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_business_manager-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/used_phone_number_id-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/provisioned_phone_number_id-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/all_phone_number_id_provisioned-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/invalid_waba_id_or_phone_number_id_for_region-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_not_found-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-12","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-13"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/internal_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/log_in_facebook_required-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/internal_error-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Comment on sender","description":"\n        Received when a comment has been added to the sender.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_938","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_938","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_938","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender completed","description":"\n        Received when a Sender is completed and ready for use.\n        ","callbackName":"Active","callbackId":"Active/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_939","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Active/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender inactive","description":"\n        Received when a sender is inactivated.\n        ","callbackName":"Inactive","callbackId":"Inactive/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_940","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_940","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Inactive/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_940","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender in pending verification","description":"\n        Received when a sender is in pending verification.\n        ","callbackName":"PendingVerification","callbackId":"PendingVerification/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_941","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_941","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"PendingVerification/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_941","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender in rejected","description":"\n        Received when a sender is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_942","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender in error","description":"\n        Received when a sender has error.\n        ","callbackName":"Error","callbackId":"Error/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_943","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_943","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Error/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_943","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Daily limit changed for Sender","description":"\n        Received when a daily limit for sender is changed.\n        ","deprecated":true,"callbackName":"DailyLimitChanged","callbackId":"DailyLimitChanged/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_944","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_944","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"DailyLimitChanged/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_944","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Quality rating changed for Sender","description":"\n        Received when a quality rating for sender is changed.\n        ","callbackName":"QualityRatingChanged","callbackId":"QualityRatingChanged/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_945","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_945","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"QualityRatingChanged/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_945","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender deleted","description":"\n        Received when a sender has been deleted.\n        ","callbackName":"Deleted","callbackId":"Deleted/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_946","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_946","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Deleted/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_946","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender display name updated","description":"\n        Received when a sender display name is updated.\n        ","callbackName":"DisplayNameUpdated","callbackId":"DisplayNameUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_947","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_947","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"DisplayNameUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_947","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender username updated","description":"\n        Received when a sender username is updated.\n        ","callbackName":"UsernameUpdated","callbackId":"UsernameUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_948","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_948","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"UsernameUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_948","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_createsender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders"},{"label":"Get sender for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_get_v1","metadata":{"seo":{"title":"Get sender for project","description":"Returns a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_get_v1","name":"Get sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","href":"whatsapp-senders/whatsappsenderscontroller_get_v1","openApiOperationId":"WhatsappSendersController_get_v1","summary":"Get sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}"},{"label":"Delete sender for project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_delete_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_delete_v1","metadata":{"seo":{"title":"Delete sender for project","description":"Marks a sender for removal. Once requested the sender will be active for 30 days to send final messages. After 30 days it will be removed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_delete_v1","name":"Delete sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Marks a sender for removal. Once requested the sender will be active for 30 days to send final messages. After 30 days it will be removed.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","href":"whatsapp-senders/whatsappsenderscontroller_delete_v1","openApiOperationId":"WhatsappSendersController_delete_v1","summary":"Delete sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Sender deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_delete_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}"},{"label":"Updates a sender in project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_update_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_update_v1","metadata":{"seo":{"title":"Updates a sender in project","description":"Updates a sender in project. Pending sender updates are tracked in \"changes\", except \"displayName\", which is tracked in \"metadata.displayName\"."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_update_v1","name":"Updates a sender in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a sender in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Updates a sender in project. Pending sender updates are tracked in \"changes\", except \"displayName\", which is tracked\n    in \"metadata.displayName\".\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username"]}},"schemaId":"components/schemas/WhatsappUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody","description":"Supported sender fields to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","href":"whatsapp-senders/whatsappsenderscontroller_update_v1","openApiOperationId":"WhatsappSendersController_update_v1","summary":"Updates a sender in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated sender in project","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_username_not_available-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_phone_number_not_registered_with_meta_cloud_api-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-6"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_username_not_available-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_phone_number_not_registered_with_meta_cloud_api-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-6"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_display_name_update_not_allowed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_username_update_not_available-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_not_found-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_has_wrong_dimensions-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-7"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_display_name_update_not_allowed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_username_update_not_available-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_not_found-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_has_wrong_dimensions-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-7"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_username_not_available-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_phone_number_not_registered_with_meta_cloud_api-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-6"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_username_not_available-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_phone_number_not_registered_with_meta_cloud_api-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-6"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_display_name_update_not_allowed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_username_update_not_available-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_not_found-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_has_wrong_dimensions-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-7"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_display_name_update_not_allowed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_username_update_not_available-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_not_found-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_has_wrong_dimensions-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-7"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Comment on sender","description":"\n        Received when a comment has been added to the sender.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_938","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_938","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_938","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender completed","description":"\n        Received when a Sender is completed and ready for use.\n        ","callbackName":"Active","callbackId":"Active/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_939","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Active/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_939","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender inactive","description":"\n        Received when a sender is inactivated.\n        ","callbackName":"Inactive","callbackId":"Inactive/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_940","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_940","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Inactive/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_940","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender in pending verification","description":"\n        Received when a sender is in pending verification.\n        ","callbackName":"PendingVerification","callbackId":"PendingVerification/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_941","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_941","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"PendingVerification/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_941","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender in rejected","description":"\n        Received when a sender is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_942","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_942","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender in error","description":"\n        Received when a sender has error.\n        ","callbackName":"Error","callbackId":"Error/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_943","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_943","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Error/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_943","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Daily limit changed for Sender","description":"\n        Received when a daily limit for sender is changed.\n        ","deprecated":true,"callbackName":"DailyLimitChanged","callbackId":"DailyLimitChanged/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_944","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_944","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"DailyLimitChanged/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_944","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Quality rating changed for Sender","description":"\n        Received when a quality rating for sender is changed.\n        ","callbackName":"QualityRatingChanged","callbackId":"QualityRatingChanged/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_945","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_945","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"QualityRatingChanged/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_945","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender deleted","description":"\n        Received when a sender has been deleted.\n        ","callbackName":"Deleted","callbackId":"Deleted/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_946","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_946","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Deleted/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_946","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender display name updated","description":"\n        Received when a sender display name is updated.\n        ","callbackName":"DisplayNameUpdated","callbackId":"DisplayNameUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_947","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_947","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"DisplayNameUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_947","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender username updated","description":"\n        Received when a sender username is updated.\n        ","callbackName":"UsernameUpdated","callbackId":"UsernameUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_948","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_948","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"UsernameUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_948","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_update_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}"},{"label":"Lists activities on sender","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on sender","description":"Paginated list of activities for sender. Ordered from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_listActivities_v1","name":"Lists activities on sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Paginated list of activities for sender. Ordered from the most recent one to the oldest one.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/activities","href":"whatsapp-senders/whatsappsenderscontroller_listactivities_v1","openApiOperationId":"WhatsappSendersController_listActivities_v1","summary":"Lists activities on sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/activities"},{"label":"Delete pending or rejected changes to a sender","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_deletechanges_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_deletechanges_v1","metadata":{"seo":{"title":"Delete pending or rejected changes to a sender","description":"Delete pending or rejected changes to a sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_deleteChanges_v1","name":"Delete pending or rejected changes to a sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete pending or rejected changes to a sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Delete pending or rejected changes to a sender.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/changes","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/changes","href":"whatsapp-senders/whatsappsenderscontroller_deletechanges_v1","openApiOperationId":"WhatsappSendersController_deleteChanges_v1","summary":"Delete pending or rejected changes to a sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Sender changes deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_deletechanges_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/changes"},{"label":"Creates a comment for a sender in project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_createcomment_v1","metadata":{"seo":{"title":"Creates a comment for a sender in project","description":"Creates a comment for a sender in project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_createComment_v1","name":"Creates a comment for a sender in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for a sender in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for a sender in project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/comments","href":"whatsapp-senders/whatsappsenderscontroller_createcomment_v1","openApiOperationId":"WhatsappSendersController_createComment_v1","summary":"Creates a comment for a sender in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for a sender in project","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_createcomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/comments"},{"label":"Register sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_register_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_register_v1","metadata":{"seo":{"title":"Register sender for project","description":"Triggers sender registration with the requested method. An OTP code will be sent over the requested method that will need to be used in the Verify sender endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_register_v1","name":"Register sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Triggers sender registration with the requested method. An OTP code will be sent over the requested method that will need to be used in the Verify sender endpoint.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappSenderInputRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappSenderInputRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody","description":"Sender register data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/register","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappSenderInputRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["200","400","401","404","409","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/register","href":"whatsapp-senders/whatsappsenderscontroller_register_v1","openApiOperationId":"WhatsappSendersController_register_v1","summary":"Register sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappSenderInputRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappSenderInputRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/phoneAlreadyRegistered"]}},"schemaId":"components/schemas/WhatsappSenderRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/phoneAlreadyRegistered"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/sender_request_code_failed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_payload-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/sender_request_code_failed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_payload-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/sender-number-not-approved-for-enterprise-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/sender-number-not-approved-for-enterprise-1"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-register-too-many-requests-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-already-registered-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/too_many_invalid_verification_codes-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-register-too-many-requests-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-already-registered-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/too_many_invalid_verification_codes-2"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSenderRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/phoneAlreadyRegistered"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSenderRegisterDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/phoneAlreadyRegistered"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/sender_request_code_failed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_payload-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/sender_request_code_failed-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_payload-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/sender-number-not-approved-for-enterprise-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/sender-number-not-approved-for-enterprise-1"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-register-too-many-requests-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-already-registered-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/too_many_invalid_verification_codes-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-register-too-many-requests-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-already-registered-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/too_many_invalid_verification_codes-2"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_register_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/register"},{"label":"Get suggested usernames for sender","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_getsuggestedusernames_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_getsuggestedusernames_v1","metadata":{"seo":{"title":"Get suggested usernames for sender","description":"Retrieves a list of suggested usernames for the specified sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_getSuggestedUsernames_v1","name":"Get suggested usernames for sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get suggested usernames for sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Retrieves a list of suggested usernames for the specified sender.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/suggestedUsernames","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/suggestedUsernames","href":"whatsapp-senders/whatsappsenderscontroller_getsuggestedusernames_v1","openApiOperationId":"WhatsappSendersController_getSuggestedUsernames_v1","summary":"Get suggested usernames for sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Suggested usernames","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSuggestedUsernamesDto"}},"schemaId":"components/schemas/WhatsappSuggestedUsernamesDto"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSuggestedUsernamesDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSuggestedUsernamesDto"}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_getsuggestedusernames_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/suggestedUsernames"},{"label":"Verify sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_verify_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-senders/whatsappsenderscontroller_verify_v1","metadata":{"seo":{"title":"Verify sender for project","description":"Verify sender with the OTP received after triggering registration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSendersController_verify_v1","name":"Verify sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Verify sender with the OTP received after triggering registration.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappSenderInputVerifyDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappSenderInputVerifyDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody","description":"Sender verification data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/verify","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappSenderInputVerifyDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/verify","href":"whatsapp-senders/whatsappsenderscontroller_verify_v1","openApiOperationId":"WhatsappSendersController_verify_v1","summary":"Verify sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappSenderInputVerifyDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappSenderInputVerifyDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Sender verified"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_payload-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_payload-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/wrong_otp-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/wrong_otp-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_payload-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_payload-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/wrong_otp-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/wrong_otp-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-senders/whatsappsenderscontroller_verify_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/verify"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Senders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Senders","showPageActions":true},{"nodeType":"markdoc","content":"A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/whatsapp/senders","summary":"List all senders in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_listsenders_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders","summary":"Create sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_createsender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","summary":"Get sender for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_get_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","summary":"Delete sender for project","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_delete_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}","summary":"Updates a sender in project","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_update_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/activities","summary":"Lists activities on sender","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/changes","summary":"Delete pending or rejected changes to a sender","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_deletechanges_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/comments","summary":"Creates a comment for a sender in project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_createcomment_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/register","summary":"Register sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_register_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/suggestedUsernames","summary":"Get suggested usernames for sender","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_getsuggestedusernames_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/senders/{senderId}/verify","summary":"Verify sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-senders/whatsappsenderscontroller_verify_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Solutions","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions","items":[{"label":"List all solutions in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_listsolutions_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_listsolutions_v1","metadata":{"seo":{"title":"List all solutions in project","description":"Returns a list of solutions for the specified project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSolutionsController_listSolutions_v1","name":"List all solutions in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all solutions in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a list of solutions for the specified project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/solutions","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/solutions","href":"whatsapp-solutions/whatsappsolutionscontroller_listsolutions_v1","openApiOperationId":"WhatsappSolutionsController_listSolutions_v1","summary":"List all solutions in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of solutions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/200/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/404/content/application~1json/examples/project_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/404/content/application~1json/examples/project_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/404/content/application~1json/examples/project_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/404/content/application~1json/examples/project_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/whatsappsolutionscontroller_listsolutions_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/solutions"},{"label":"Create solution for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_createsolution_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_createsolution_v1","metadata":{"seo":{"title":"Create solution for project","description":"Returns all solutions for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSolutionsController_createSolution_v1","name":"Create solution for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create solution for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns all solutions for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappSolutionInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody","description":"Solution data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/solutions","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/solutions","href":"whatsapp-solutions/whatsappsolutionscontroller_createsolution_v1","openApiOperationId":"WhatsappSolutionsController_createSolution_v1","summary":"Create solution for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappSolutionInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Solutions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCreateSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappCreateSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/201/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/404/content/application~1json/examples/project_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/404/content/application~1json/examples/project_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappCreateSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCreateSolutionListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/201/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/404/content/application~1json/examples/project_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/404/content/application~1json/examples/project_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/whatsappsolutionscontroller_createsolution_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/solutions"},{"label":"Get solution for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_getsolution_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_getsolution_v1","metadata":{"seo":{"title":"Get solution for project","description":"Returns a solution for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSolutionsController_getSolution_v1","name":"Get solution for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get solution for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a solution for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"solutionId","in":"path","schemaId":"schema_922","description":"The unique ID of the solution.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"solutionId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}","href":"whatsapp-solutions/whatsappsolutionscontroller_getsolution_v1","openApiOperationId":"WhatsappSolutionsController_getSolution_v1","summary":"Get solution for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Solution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/assignedResponse","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/notAssignedResponse"]}},"schemaId":"components/schemas/WhatsappSolutionDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/assignedResponse","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/notAssignedResponse"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/solution_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/solution_not_found-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappSolutionDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/assignedResponse","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/notAssignedResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappSolutionDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/assignedResponse","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/notAssignedResponse"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/solution_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/solution_not_found-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/whatsappsolutionscontroller_getsolution_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}"},{"label":"Assign solution to project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_assignsolution_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-solutions/whatsappsolutionscontroller_assignsolution_v1","metadata":{"seo":{"title":"Assign solution to project","description":"Assign solution to project, to enable Embedded Signup onboarding."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappSolutionsController_assignSolution_v1","name":"Assign solution to project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign solution to project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Assign solution to project, to enable Embedded Signup onboarding.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"solutionId","in":"path","schemaId":"schema_922","description":"The unique ID of the solution.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}/assign","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"solutionId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}/assign","href":"whatsapp-solutions/whatsappsolutionscontroller_assignsolution_v1","openApiOperationId":"WhatsappSolutionsController_assignSolution_v1","summary":"Assign solution to project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Solution assigned"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/solution_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/solution_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/409/content/application~1json/examples/solution_cannot_be_reassigned-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/409/content/application~1json/examples/solution_cannot_be_reassigned-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/solution_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/solution_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/409/content/application~1json/examples/solution_cannot_be_reassigned-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/409/content/application~1json/examples/solution_cannot_be_reassigned-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-solutions/whatsappsolutionscontroller_assignsolution_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}/assign"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Solutions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Solutions","showPageActions":true},{"nodeType":"markdoc","content":"The WhatsApp solutions endpoint offers a way for you to manage your WhatsApp solutions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/whatsapp/solutions","summary":"List all solutions in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-solutions/whatsappsolutionscontroller_listsolutions_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/solutions","summary":"Create solution for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-solutions/whatsappsolutionscontroller_createsolution_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}","summary":"Get solution for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-solutions/whatsappsolutionscontroller_getsolution_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/solutions/{solutionId}/assign","summary":"Assign solution to project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-solutions/whatsappsolutionscontroller_assignsolution_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Templates","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates","items":[{"label":"List all templates in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_listtemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_listtemplates_v1","metadata":{"seo":{"title":"List all templates in project","description":"Returns a paginated list of templates for the specified project. If no page token is supplied then the first 50 templates are returned in alphabetical order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_listTemplates_v1","name":"List all templates in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all templates in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of templates for the specified project. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" templates are returned in alphabetical order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_949","description":"The page size requested."},{"name":"fieldMask","in":"query","schemaId":"schema_950","description":"Field masks are a way for API callers to list the fields that a request should return."},{"name":"filterStates","in":"query","schemaId":"schema_951","description":"Optionally query for sender by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_952","description":"Optionally query for sender by statuses."},{"name":"templateAnalyticsDateRange","in":"query","schemaId":"schema_953","description":"The date range to retrieve template analytics for. Fallback to DAY if none is set."},{"name":"templateName","in":"query","schemaId":"schema_922","description":"Optionally query for template by name. Will return all templates with names that begin with the query string."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/templates","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_949"},{"name":"fieldMask","in":"query","required":false,"schemaId":"schema_950"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_951"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_952"},{"name":"templateAnalyticsDateRange","in":"query","required":false,"schemaId":"components/schemas/WhatsappTemplateAnalyticsDateRangesEnum"},{"name":"templateName","in":"query","required":false,"schemaId":"schema_922"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates","href":"whatsapp-templates/whatsapptemplatescontroller_listtemplates_v1","openApiOperationId":"WhatsappTemplatesController_listTemplates_v1","summary":"List all templates in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of templates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_954"}},"schemaId":"schema_954"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_fields-5"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_fields-5"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_954","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_954"}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_fields-5"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_fields-5"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_listtemplates_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates"},{"label":"Create a template in project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_createtemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_createtemplate_v1","metadata":{"seo":{"title":"Create a template in project","description":"Creates a new template with the request data. If the status field is set to submit the template will be created immediately, otherwise it will be saved as a draft."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_createTemplate_v1","name":"Create a template in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a template in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new template with the request data. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the template will be created immediately, otherwise it will be saved as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing"]}},"schemaId":"components/schemas/WhatsappTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody","description":"Template data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/templates","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing"]}},"responseCodes":["201","400","401","409","424","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates","href":"whatsapp-templates/whatsapptemplatescontroller_createtemplate_v1","openApiOperationId":"WhatsappTemplatesController_createTemplate_v1","summary":"Create a template in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_dynamic_pricing_not_available-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_category-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_button_example-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/file_invalid_mime_type-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_payload-9"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_dynamic_pricing_not_available-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_category-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_button_example-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/file_invalid_mime_type-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_payload-9"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_name_recently_used-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_incorrect_category-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_not_found-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_size_too_large-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_unexpected_error-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_language_recently_deleted-9"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_name_recently_used-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_incorrect_category-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_not_found-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_size_too_large-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_unexpected_error-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_language_recently_deleted-9"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_submit_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_submit_error-2"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-2"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_dynamic_pricing_not_available-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_category-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_button_example-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/file_invalid_mime_type-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_payload-9"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_dynamic_pricing_not_available-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_category-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_button_example-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/file_invalid_mime_type-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_payload-9"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_name_recently_used-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_incorrect_category-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_not_found-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_size_too_large-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_unexpected_error-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_language_recently_deleted-9"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_name_recently_used-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_incorrect_category-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_not_found-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_size_too_large-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_unexpected_error-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_language_recently_deleted-9"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_submit_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_submit_error-2"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template received a comment","description":"\n      Callback sent when a comment is placed on a template.\n      ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_955","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_955","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_955","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template approved","description":"\n        Callback sent when a template is approved.\n        ","callbackName":"Approved","callbackId":"Approved/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_956","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_956","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Approved/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_956","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template rejected","description":"\n        Callback sent when a template is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_957","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_957","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_957","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template status updated","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callback sent when a template status in changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ARCHIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FLAGGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAUSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REINSTATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNPAUSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"StatusUpdated","callbackId":"StatusUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_958","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_958","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"StatusUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_958","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template deleted","description":"Callback sent when a template is deleted.","callbackName":"Deleted","callbackId":"Deleted/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_959","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_959","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Deleted/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_959","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template quality score updated","description":"\n        Callback sent when a template quality score changed.\n        ","callbackName":"QualityScoreUpdated","callbackId":"QualityScoreUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_960","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"QualityScoreUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template category updated","description":"\n        Callback sent when a templates category is changed.\n        ","callbackName":"CategoryUpdated","callbackId":"CategoryUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_961","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"CategoryUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template category coming update","description":"\n        Callback sent when a templates category coming to be changed.\n        ","callbackName":"FutureCategoryUpdate","callbackId":"FutureCategoryUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_962","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"FutureCategoryUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_createtemplate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates"},{"label":"List all templates for a specific name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_listtemplatesbyname_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_listtemplatesbyname_v1","metadata":{"seo":{"title":"List all templates for a specific name","description":"Returns a paginated list of templates for the specified project and name. If no page token is supplied then the first 50 templates are returned in alphabetical order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_listTemplatesByName_v1","name":"List all templates for a specific name","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all templates for a specific name","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of templates for the specified project and name. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" templates are returned in alphabetical order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_949","description":"The page size requested."},{"name":"fieldMask","in":"query","schemaId":"schema_950","description":"Field masks are a way for API callers to list the fields that a request should return."},{"name":"templateAnalyticsDateRange","in":"query","schemaId":"schema_953","description":"The date range to retrieve template analytics for. Fallback to DAY if none is set."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_949"},{"name":"fieldMask","in":"query","required":false,"schemaId":"schema_950"},{"name":"templateAnalyticsDateRange","in":"query","required":false,"schemaId":"components/schemas/WhatsappTemplateAnalyticsDateRangesEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}","href":"whatsapp-templates/whatsapptemplatescontroller_listtemplatesbyname_v1","openApiOperationId":"WhatsappTemplatesController_listTemplatesByName_v1","summary":"List all templates for a specific name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of templates with the same name","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_954"}},"schemaId":"schema_954"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_fields-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_fields-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_954","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_954"}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_fields-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_fields-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_listtemplatesbyname_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}"},{"label":"Delete template by name","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_deletetemplatesbyname_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_deletetemplatesbyname_v1","metadata":{"seo":{"title":"Delete template by name","description":"Delete template that matches the name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_deleteTemplatesByName_v1","name":"Delete template by name","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template by name","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n      Delete template that matches the name.\n\n      If message templates with the same name exists in multiple languages, all those templates will also be deleted.      \n      Once deleted the name can not be used for new message templates for 30 days. Use a different name to create future templates during that time period.\n      Messages that have been sent with the deleted template, but not yet delivered, will be attempted to be deliver for 30 days from the time of the message.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}","href":"whatsapp-templates/whatsapptemplatescontroller_deletetemplatesbyname_v1","openApiOperationId":"WhatsappTemplatesController_deleteTemplatesByName_v1","summary":"Delete template by name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Template(s) deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/409/content/application~1json/examples/resource_locked-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/409/content/application~1json/examples/resource_locked-0"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/409/content/application~1json/examples/resource_locked-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/409/content/application~1json/examples/resource_locked-0"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_deletetemplatesbyname_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}"},{"label":"Get template in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_gettemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_gettemplate_v1","metadata":{"seo":{"title":"Get template in project","description":"Returns a template for a project, with the specified name and language."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_getTemplate_v1","name":"Get template in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a template for a project, with the specified name and language.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_963","description":"The language code of the specific template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fieldMask","in":"query","schemaId":"schema_950","description":"Field masks are a way for API callers to list the fields that a request should return."},{"name":"templateAnalyticsDateRange","in":"query","schemaId":"schema_953","description":"The date range to retrieve template analytics for. Fallback to DAY if none is set."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguagesEnum"}],"query":[{"name":"fieldMask","in":"query","required":false,"schemaId":"schema_950"},{"name":"templateAnalyticsDateRange","in":"query","required":false,"schemaId":"components/schemas/WhatsappTemplateAnalyticsDateRangesEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","href":"whatsapp-templates/whatsapptemplatescontroller_gettemplate_v1","openApiOperationId":"WhatsappTemplatesController_getTemplate_v1","summary":"Get template in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_964"}},"schemaId":"schema_964"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/invalid_fields-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/invalid_fields-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_964","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_964"}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/invalid_fields-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/invalid_fields-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_gettemplate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}"},{"label":"Delete template by name and language","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_deletetemplatebynameandlanguage_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_deletetemplatebynameandlanguage_v1","metadata":{"seo":{"title":"Delete template by name and language","description":"Delete a template by name and language."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_deleteTemplateByNameAndLanguage_v1","name":"Delete template by name and language","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template by name and language","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a template by name and language."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that by default only draft is removed. Use query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleteSubmitted=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to also remove the submitted template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once an approved template is deleted, the template cannot be recreated again with this name and language for 30 days. Consequently, be aware that you must use a different name to create template for this language within this 30 days long period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need the template in this language soon, update the submitted template for a specific language instead of trying to delete and recreate it again."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_963","description":"The language code of the specific template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleteSubmitted","in":"query","schemaId":"schema_965","description":"Set this flag to true if you want to delete a template already submitted to Meta. Otherwise, it defaults to false, meaning that it deletes a template in \"draft\" state only, and throws an error if you attempt to delete a submitted template."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguagesEnum"}],"query":[{"name":"deleteSubmitted","in":"query","required":false,"schemaId":"schema_965"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","href":"whatsapp-templates/whatsapptemplatescontroller_deletetemplatebynameandlanguage_v1","openApiOperationId":"WhatsappTemplatesController_deleteTemplateByNameAndLanguage_v1","summary":"Delete template by name and language"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Template deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_changes_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_changes_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/template_not_deletable_due_to_input_config-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/template_not_deletable_due_to_input_config-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_changes_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_changes_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/template_not_deletable_due_to_input_config-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/template_not_deletable_due_to_input_config-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_deletetemplatebynameandlanguage_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}"},{"label":"Update a template in project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_updatetemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_updatetemplate_v1","metadata":{"seo":{"title":"Update a template in project","description":"Updates a template DRAFT."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_updateTemplate_v1","name":"Update a template in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a template in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Updates a template DRAFT.\n    \n    Note that it is not possible to update all fields for a template,\n    if you want to update a field that is not supported you will need to delete the draft and create a new one.\n\n    Update a template REJECTED / APPROVED / PAUSED / DISABLED\n\n    It is possible to update templates that have been rejected, approved, paused or disabled, we will automatically set the status to draft when update a rejected template.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_963","description":"The language code of the specific template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappUpdateTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides"]}},"schemaId":"components/schemas/WhatsappUpdateTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody","description":"Supported template fields to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguagesEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappUpdateTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides"]}},"responseCodes":["200","400","401","404","409","424","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","href":"whatsapp-templates/whatsapptemplatescontroller_updatetemplate_v1","openApiOperationId":"WhatsappTemplatesController_updateTemplate_v1","summary":"Update a template in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappUpdateTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappUpdateTemplateInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated template draft","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_button_example-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/invalid_payload-7"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_button_example-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/invalid_payload-7"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_category_not_updatable-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_allow_category_change_not_updatable-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_source_not_updatable-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_name_recently_used-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_not_found-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_size_too_large-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_unexpected_error-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_language_recently_deleted-12"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_category_not_updatable-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_allow_category_change_not_updatable-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_source_not_updatable-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_name_recently_used-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_not_found-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_size_too_large-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_unexpected_error-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_language_recently_deleted-12"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_submit_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_submit_error-2"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-2"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_button_example-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/invalid_payload-7"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_policies_violations-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_check_media_file_size-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_button_example-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/invalid_payload-7"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_category_not_updatable-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_allow_category_change_not_updatable-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_source_not_updatable-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_name_recently_used-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_not_found-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_size_too_large-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_unexpected_error-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_language_recently_deleted-12"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_category_not_updatable-3","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_allow_category_change_not_updatable-4","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_source_not_updatable-5","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_name_recently_used-6","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-7","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_not_found-8","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_size_too_large-9","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_unexpected_error-10","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-11","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_language_recently_deleted-12"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_submit_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_limit_reached-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_content_already_exists-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_submit_error-2"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template received a comment","description":"\n      Callback sent when a comment is placed on a template.\n      ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_955","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_955","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_955","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template approved","description":"\n        Callback sent when a template is approved.\n        ","callbackName":"Approved","callbackId":"Approved/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_956","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_956","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Approved/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_956","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template rejected","description":"\n        Callback sent when a template is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_957","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_957","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_957","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template status updated","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callback sent when a template status in changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ARCHIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FLAGGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAUSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REINSTATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNPAUSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"StatusUpdated","callbackId":"StatusUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_958","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_958","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"StatusUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_958","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template deleted","description":"Callback sent when a template is deleted.","callbackName":"Deleted","callbackId":"Deleted/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_959","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_959","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Deleted/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_959","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template quality score updated","description":"\n        Callback sent when a template quality score changed.\n        ","callbackName":"QualityScoreUpdated","callbackId":"QualityScoreUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_960","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"QualityScoreUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_960","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template category updated","description":"\n        Callback sent when a templates category is changed.\n        ","callbackName":"CategoryUpdated","callbackId":"CategoryUpdated/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_961","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"CategoryUpdated/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_961","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"WhatsApp Template category coming update","description":"\n        Callback sent when a templates category coming to be changed.\n        ","callbackName":"FutureCategoryUpdate","callbackId":"FutureCategoryUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_962","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"FutureCategoryUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_962","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_updatetemplate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}"},{"label":"Lists activities on project template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on project template","description":"Paginated list of activities for a template. Ordered from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_listActivities_v1","name":"Lists activities on project template","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on project template","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Paginated list of activities for a template. Ordered from the most recent one to the oldest one.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_963","description":"The language code of the specific template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguagesEnum"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/activities","href":"whatsapp-templates/whatsapptemplatescontroller_listactivities_v1","openApiOperationId":"WhatsappTemplatesController_listActivities_v1","summary":"Lists activities on project template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/WhatsappTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/template_invalid_language_code-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/activities"},{"label":"Creates a comment for a template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_createcomment_v1","metadata":{"seo":{"title":"Creates a comment for a template","description":"Creates a comment for a template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_createComment_v1","name":"Creates a comment for a template","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for a template","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for a template.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_963","description":"The language code of the specific template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguagesEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments","href":"whatsapp-templates/whatsapptemplatescontroller_createcomment_v1","openApiOperationId":"WhatsappTemplatesController_createComment_v1","summary":"Creates a comment for a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for a template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/409/content/application~1json/examples/resource_locked-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/409/content/application~1json/examples/resource_locked-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/409/content/application~1json/examples/resource_locked-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/409/content/application~1json/examples/resource_locked-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_createcomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments"},{"label":"Compare two templates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_comparetemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_comparetemplates_v1","metadata":{"seo":{"title":"Compare two templates","description":"Compare two templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_compareTemplates_v1","name":"Compare two templates","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compare two templates","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Compare two templates.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"templateName","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true},{"name":"languageCode","in":"path","schemaId":"schema_963","description":"The language code of the specific template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappInputTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappInputTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody","description":"Compare data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/compare","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateName","in":"path","required":true,"schemaId":"schema_922"},{"name":"languageCode","in":"path","required":true,"schemaId":"components/schemas/WhatsappTemplateLanguagesEnum"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappInputTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/compare","href":"whatsapp-templates/whatsapptemplatescontroller_comparetemplates_v1","openApiOperationId":"WhatsappTemplatesController_compareTemplates_v1","summary":"Compare two templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappInputTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappInputTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Compared template response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/200/content/application~1json/examples/created"]}},"schemaId":"components/schemas/WhatsappTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/200/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_payload-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_payload-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/templates_compare_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/templates_compare_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_not_eligible_for_comparison-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_compare_not_unique-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_not_eligible_for_comparison-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_compare_not_unique-2"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WhatsappTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/200/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WhatsappTemplateCompareDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/200/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_payload-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_payload-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/templates_compare_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/templates_compare_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_not_eligible_for_comparison-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_compare_not_unique-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/resource_locked-0","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_not_eligible_for_comparison-1","paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_compare_not_unique-2"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_comparetemplates_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/compare"},{"label":"Synchronize templates for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_synctemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/whatsapp-templates/whatsapptemplatescontroller_synctemplates_v1","metadata":{"seo":{"title":"Synchronize templates for project","description":"Synchronize templates for project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WhatsappTemplatesController_syncTemplates_v1","name":"Synchronize templates for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Synchronize templates for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Synchronize templates for project\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/whatsapp/templates/sync","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","409","429","500"],"pointer":"/v1/projects/{projectId}/whatsapp/templates/sync","href":"whatsapp-templates/whatsapptemplatescontroller_synctemplates_v1","openApiOperationId":"WhatsappTemplatesController_syncTemplates_v1","summary":"Synchronize templates for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Templates have been synchronized for project"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/409/content/application~1json/examples/resource_locked-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/409/content/application~1json/examples/resource_locked-0"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/429/content/application~1json/examples/too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/429/content/application~1json/examples/too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/409/content/application~1json/examples/resource_locked-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/409/content/application~1json/examples/resource_locked-0"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/429/content/application~1json/examples/too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/429/content/application~1json/examples/too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/whatsapptemplatescontroller_synctemplates_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/whatsapp/templates/sync"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Templates","showPageActions":true},{"nodeType":"markdoc","content":"The WhatsApp template endpoint offers a way for you to manage your WhatsApp templates that can be used with the Conversation API. The WhatsApp templates are a requirement to send the initial outbound messages in the WhatsApp API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/whatsapp/templates","summary":"List all templates in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_listtemplates_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates","summary":"Create a template in project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_createtemplate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}","summary":"List all templates for a specific name","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_listtemplatesbyname_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}","summary":"Delete template by name","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_deletetemplatesbyname_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","summary":"Get template in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_gettemplate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","summary":"Delete template by name and language","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_deletetemplatebynameandlanguage_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}","summary":"Update a template in project","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_updatetemplate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/activities","summary":"Lists activities on project template","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/comments","summary":"Creates a comment for a template","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_createcomment_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}/compare","summary":"Compare two templates","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_comparetemplates_v1","deprecated":false},{"title":"/v1/projects/{projectId}/whatsapp/templates/sync","summary":"Synchronize templates for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/whatsapp-templates/whatsapptemplatescontroller_synctemplates_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"Bundles","content":null},{"type":"group","label":"Bundles","link":"/docs/provisioning-api/api-reference/provisioning-api/bundles","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/bundles","items":[{"label":"List bundles by projectId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlesbundlescontroller_list_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlesbundlescontroller_list_v1","metadata":{"seo":{"title":"List bundles by projectId","description":"Returns a paginated list of bundles for a given project, optionally filtered by SMS App IDs, Conversation App IDs, or bundle states. If no page token is supplied then the first 10 will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BundlesBundlesController_list_v1","name":"List bundles by projectId","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bundles by projectId","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of bundles for a given project, optionally filtered by SMS App IDs, Conversation App IDs, or bundle states. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_966","description":"The page size requested."},{"name":"filterConvAppIds","in":"query","schemaId":"schema_967","description":"Optional query for filtering by Conversation App IDs."},{"name":"filterSmsAppIds","in":"query","schemaId":"schema_967","description":"Optional query for filtering by SMS App IDs."},{"name":"filterStates","in":"query","schemaId":"schema_968","description":"Optional query for filtering by bundle states."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/bundles","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_966"},{"name":"filterConvAppIds","in":"query","required":false,"schemaId":"schema_967"},{"name":"filterSmsAppIds","in":"query","required":false,"schemaId":"schema_967"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_968"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/projects/{projectId}/bundles","href":"bundles/bundlesbundlescontroller_list_v1","openApiOperationId":"BundlesBundlesController_list_v1","summary":"List bundles by projectId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of bundles","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BundlesListBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/BundlesListBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_id_format-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_id_format-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BundlesListBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BundlesListBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_id_format-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_id_format-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundles/bundlesbundlescontroller_list_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/bundles"},{"label":"Create bundle for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlesbundlescontroller_create_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlesbundlescontroller_create_v1","metadata":{"seo":{"title":"Create bundle for project","description":"Creates a new bundle of resources based on the input work order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BundlesBundlesController_create_v1","name":"Create bundle for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bundle for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a new bundle of resources based on the input work order.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_969","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full"]}},"schemaId":"schema_969","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody","description":"Example Bundle create requests"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/bundles","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_969","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full"]}},"responseCodes":["201","400","401","403","404","409","424","500"],"pointer":"/v1/projects/{projectId}/bundles","href":"bundles/bundlesbundlescontroller_create_v1","openApiOperationId":"BundlesBundlesController_create_v1","summary":"Create bundle for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"schema_969","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_969","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responds with the bundle created. At time of response the bundle might not be completed. To receive the complete payload register a webhook for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUNDLE_DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" trigger."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/ready"]}},"schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/ready"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/no_services_to_create-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/missing_name-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_webhooks-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_staging_bundles_input_region-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_bespoke_price-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/target_project_not_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_not_route_assisted-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/conversation_app_already_connected_to_sms_app-9"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/no_services_to_create-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/missing_name-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_webhooks-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_staging_bundles_input_region-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_bespoke_price-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/target_project_not_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_not_route_assisted-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/conversation_app_already_connected_to_sms_app-9"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/403/content/application~1json/examples/forbidden_payload-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/403/content/application~1json/examples/forbidden_payload-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/sms_app_not_found-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/default_sms_app_not_found-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/sms_app_not_found-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/default_sms_app_not_found-2"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/webhook_exists-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/conversation_app_is_already_in_bundles_process-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/default_sms_app_already_exists-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/more_than_one_sms_app-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_linked_to_conversation_app-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_in_bundles_process-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/allowed_only_for_default_test_sms_app-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_non_test_account-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/only_one_test_number_allowed-9"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/webhook_exists-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/conversation_app_is_already_in_bundles_process-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/default_sms_app_already_exists-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/more_than_one_sms_app-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_linked_to_conversation_app-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_in_bundles_process-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/allowed_only_for_default_test_sms_app-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_non_test_account-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/only_one_test_number_allowed-9"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_subproject-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_sms_service-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_conversation_service-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/internal_error-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_subproject-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_sms_service-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_conversation_service-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/internal_error-3"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/ready"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/ready"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/no_services_to_create-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/missing_name-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_webhooks-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_staging_bundles_input_region-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_bespoke_price-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/target_project_not_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_not_route_assisted-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/conversation_app_already_connected_to_sms_app-9"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/no_services_to_create-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/missing_name-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_webhooks-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_staging_bundles_input_region-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_bespoke_price-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/target_project_not_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_not_route_assisted-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/conversation_app_already_connected_to_sms_app-9"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/403/content/application~1json/examples/forbidden_payload-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/403/content/application~1json/examples/forbidden_payload-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/sms_app_not_found-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/default_sms_app_not_found-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/sms_app_not_found-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/default_sms_app_not_found-2"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/webhook_exists-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/conversation_app_is_already_in_bundles_process-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/default_sms_app_already_exists-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/more_than_one_sms_app-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_linked_to_conversation_app-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_in_bundles_process-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/allowed_only_for_default_test_sms_app-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_non_test_account-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/only_one_test_number_allowed-9"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/webhook_exists-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/conversation_app_is_already_in_bundles_process-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/default_sms_app_already_exists-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/more_than_one_sms_app-3","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_linked_to_conversation_app-4","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_in_bundles_process-5","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/allowed_only_for_default_test_sms_app-6","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_subproject-7","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_non_test_account-8","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/only_one_test_number_allowed-9"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_subproject-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_sms_service-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_conversation_service-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/internal_error-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_subproject-0","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_sms_service-1","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_conversation_service-2","paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/internal_error-3"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Bundle Done Event","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a bundle is completed, the system makes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the specified callback URL."},"children":[]}]}]}],"callbackName":"BundleDone","callbackId":"BundleDone/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_970","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_970","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"BundleDone/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_970","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundles/bundlesbundlescontroller_create_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/bundles"},{"label":"Get bundle by projectId and bundleId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlesbundlescontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/bundles/bundlesbundlescontroller_get_v1","metadata":{"seo":{"title":"Get bundle by projectId and bundleId","description":"Retrieve created bundle and resources created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BundlesBundlesController_get_v1","name":"Get bundle by projectId and bundleId","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bundle by projectId and bundleId","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Retrieve created bundle and resources created.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"bundleId","in":"path","schemaId":"schema_922","description":"The unique ID of the bundle.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/bundles/{bundleId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"bundleId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/bundles/{bundleId}","href":"bundles/bundlesbundlescontroller_get_v1","openApiOperationId":"BundlesBundlesController_get_v1","summary":"Get bundle by projectId and bundleId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Responds with the bundle created. At time of response the bundle might not be completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/ready"]}},"schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/ready"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/bundle_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/conversation_app_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/bundle_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/conversation_app_not_found-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/ready"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BundlesBundlesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/notReady","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/ready"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/bundle_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/conversation_app_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/bundle_not_found-0","paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/conversation_app_not_found-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bundles/bundlesbundlescontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/bundles/{bundleId}"}],"content":{"contentType":"group","meta":{"name":"Bundles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bundles","showPageActions":true},{"nodeType":"markdoc","content":"The bundles endpoint allows you to create and manage bundles of account resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/bundles","summary":"List bundles by projectId","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/bundles/bundlesbundlescontroller_list_v1","deprecated":false},{"title":"/v1/projects/{projectId}/bundles","summary":"Create bundle for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/bundles/bundlesbundlescontroller_create_v1","deprecated":false},{"title":"/v1/projects/{projectId}/bundles/{bundleId}","summary":"Get bundle by projectId and bundleId","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/bundles/bundlesbundlescontroller_get_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"KakaoTalk","content":null},{"type":"group","label":"KakaoTalk Categories","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories","items":[{"label":"List all sender categories.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories/kakaotalkcategoriescontroller_listsendercategories_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories/kakaotalkcategoriescontroller_listsendercategories_v1","metadata":{"seo":{"title":"List all sender categories.","description":"Returns a list of sender categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkCategoriesController_listSenderCategories_v1","name":"List all sender categories.","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all sender categories.","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a list of sender categories.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/categories/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/categories/senders","href":"kakaotalk-categories/kakaotalkcategoriescontroller_listsendercategories_v1","openApiOperationId":"KakaotalkCategoriesController_listSenderCategories_v1","summary":"List all sender categories."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of sender categories.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-categories/kakaotalkcategoriescontroller_listsendercategories_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/categories/senders"},{"label":"List all template categories in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories/kakaotalkcategoriescontroller_gettemplatecategories_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-categories/kakaotalkcategoriescontroller_gettemplatecategories_v1","metadata":{"seo":{"title":"List all template categories in project","description":"Returns a list of template categories for the specified project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkCategoriesController_getTemplateCategories_v1","name":"List all template categories in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all template categories in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a list of template categories for the specified project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/categories/senders/{plusFriendId}/templates","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/categories/senders/{plusFriendId}/templates","href":"kakaotalk-categories/kakaotalkcategoriescontroller_gettemplatecategories_v1","openApiOperationId":"KakaotalkCategoriesController_getTemplateCategories_v1","summary":"List all template categories in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of template categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkTemplateCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkTemplateCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateCategoryListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-categories/kakaotalkcategoriescontroller_gettemplatecategories_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/categories/senders/{plusFriendId}/templates"}],"content":{"contentType":"group","meta":{"name":"KakaoTalk Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KakaoTalk Categories","showPageActions":true},{"nodeType":"markdoc","content":"The KakaoTalk categories endpoint offers a way for you to manage all of the KakaoTalk template categories that you can use with the Conversation API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/kakaotalk/categories/senders","summary":"List all sender categories.","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-categories/kakaotalkcategoriescontroller_listsendercategories_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/categories/senders/{plusFriendId}/templates","summary":"List all template categories in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-categories/kakaotalkcategoriescontroller_gettemplatecategories_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"KakaoTalk Senders","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders","items":[{"label":"List all senders in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1","metadata":{"seo":{"title":"List all senders in project","description":"Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_listSenders_v1","name":"List all senders in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all senders in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of senders for the specified project. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"filterStates","in":"query","schemaId":"schema_971","description":"Optionally query for sender by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_972","description":"Optionally query for sender by statuses."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_971"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_972"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders","href":"kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1","openApiOperationId":"KakaotalkSendersController_listSenders_v1","summary":"List all senders in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of senders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders"},{"label":"Create sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_createsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_createsender_v1","metadata":{"seo":{"title":"Create sender for project","description":"Creates a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_createSender_v1","name":"Create sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n        Creates a sender for a project.\n        "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal"]}},"schemaId":"components/schemas/KakaotalkInputSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody","description":"Sender data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/kakaotalk/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KakaotalkInputSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal"]}},"responseCodes":["201","400","401","404","409","412","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders","href":"kakaotalk-senders/kakaotalksenderscontroller_createsender_v1","openApiOperationId":"KakaotalkSendersController_createSender_v1","summary":"Create sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/KakaotalkInputSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/sender_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/invalid_input-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/sender_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/invalid_input-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_not_found-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/plus_friend_id_used-6"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_not_found-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/plus_friend_id_used-6"]},{"code":"412","description":"PreconditionFailed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/412/content/application~1json/examples/account_is_in_progress-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/412/content/application~1json/examples/account_is_in_progress-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/sender_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/invalid_input-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/sender_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/invalid_input-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_not_found-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/plus_friend_id_used-6"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_not_found-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-5","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/plus_friend_id_used-6"]}}},{"code":"412","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/412/content/application~1json/examples/account_is_in_progress-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/412/content/application~1json/examples/account_is_in_progress-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender state active","description":"\n        Received when sender verification is complete and sender is ready to use.\n        ","callbackName":"Active","callbackId":"Active/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_973","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_973","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Active/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_973","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender inactive","description":"\n        Received when a sender is inactivated.\n        ","callbackName":"Inactive","callbackId":"Inactive/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_974","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_974","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Inactive/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_974","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender rejected","description":"\n        Received when a sender is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_975","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_975","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_975","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Comment on sender","description":"\n        Received when a comment has been added to the sender.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_976","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_976","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_976","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_createsender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders"},{"label":"Get sender for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_getsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_getsender_v1","metadata":{"seo":{"title":"Get sender for project","description":"Returns a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_getSender_v1","name":"Get sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","href":"kakaotalk-senders/kakaotalksenderscontroller_getsender_v1","openApiOperationId":"KakaotalkSendersController_getSender_v1","summary":"Get sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_getsender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}"},{"label":"Delete sender for project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_deletesender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_deletesender_v1","metadata":{"seo":{"title":"Delete sender for project","description":"Marks a sender for removal. Once requested the sender will be active for 60 days to deliver final messages. After 60 days it will be removed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_deleteSender_v1","name":"Delete sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Marks a sender for removal. Once requested the sender will be active for 60 days to deliver final messages. After 60 days it will be removed.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","href":"kakaotalk-senders/kakaotalksenderscontroller_deletesender_v1","openApiOperationId":"KakaotalkSendersController_deleteSender_v1","summary":"Delete sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Sender marked for delete after 60 days."},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_deletesender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}"},{"label":"Updates a draft sender in project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_updatesender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_updatesender_v1","metadata":{"seo":{"title":"Updates a draft sender in project","description":"Updates a draft sender in project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_updateSender_v1","name":"Updates a draft sender in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a draft sender in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Updates a draft sender in project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputUpdateSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full"]}},"schemaId":"components/schemas/KakaotalkInputUpdateSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody","description":"Supported sender fields to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KakaotalkInputUpdateSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","href":"kakaotalk-senders/kakaotalksenderscontroller_updatesender_v1","openApiOperationId":"KakaotalkSendersController_updateSender_v1","summary":"Updates a draft sender in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/KakaotalkInputUpdateSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputUpdateSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated sender in project","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/responseSenderDraft"]}},"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/responseSenderDraft"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/sender_invalid_category_code-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/sender_invalid_category_code-4"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/sender_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/sender_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-4"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/responseSenderDraft"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/response","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/responseSenderDraft"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/sender_invalid_category_code-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/project_not_initialized-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/sender_invalid_category_code-4"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/sender_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/sender_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-3","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-4"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_updatesender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}"},{"label":"Lists activities on sender","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on sender","description":"Paginated list of activities for sender. Ordered from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_listActivities_v1","name":"Lists activities on sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginated list of activities for sender. Ordered from the most recent one to the oldest one."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities","href":"kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1","openApiOperationId":"KakaotalkSendersController_listActivities_v1","summary":"Lists activities on sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities"},{"label":"Delete pending or rejected changes to a sender","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1","metadata":{"seo":{"title":"Delete pending or rejected changes to a sender","description":"Delete pending or rejected changes to a sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_deleteChanges_v1","name":"Delete pending or rejected changes to a sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete pending or rejected changes to a sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Delete pending or rejected changes to a sender.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/changes","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/changes","href":"kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1","openApiOperationId":"KakaotalkSendersController_deleteChanges_v1","summary":"Delete pending or rejected changes to a sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Sender changes deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/changes"},{"label":"Creates a comment for a sender in project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1","metadata":{"seo":{"title":"Creates a comment for a sender in project","description":"Creates a comment for a sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_createComment_v1","name":"Creates a comment for a sender in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for a sender in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for a sender.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/comments","href":"kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1","openApiOperationId":"KakaotalkSendersController_createComment_v1","summary":"Creates a comment for a sender in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for a sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/comments"},{"label":"Register sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_registersender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_registersender_v1","metadata":{"seo":{"title":"Register sender for project","description":"Requests sender registration for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_registerSender_v1","name":"Register sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Requests sender registration for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/register","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/register","href":"kakaotalk-senders/kakaotalksenderscontroller_registersender_v1","openApiOperationId":"KakaotalkSendersController_registerSender_v1","summary":"Register sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/invalid_app_key-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/invalid_app_key-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/invalid_app_key-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/invalid_app_key-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_registersender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/register"},{"label":"Verify sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_verifysender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-senders/kakaotalksenderscontroller_verifysender_v1","metadata":{"seo":{"title":"Verify sender for project","description":"Verifies sender with the OTP code received after triggering registration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkSendersController_verifySender_v1","name":"Verify sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Verifies sender with the OTP code received after triggering registration.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputVerifySenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/KakaotalkInputVerifySenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody","description":"Verify sender data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KakaotalkInputVerifySenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["200","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify","href":"kakaotalk-senders/kakaotalksenderscontroller_verifysender_v1","openApiOperationId":"KakaotalkSendersController_verifySender_v1","summary":"Verify sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/KakaotalkInputVerifySenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputVerifySenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-senders/kakaotalksenderscontroller_verifysender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify"}],"content":{"contentType":"group","meta":{"name":"KakaoTalk Senders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KakaoTalk Senders","showPageActions":true},{"nodeType":"markdoc","content":"The KakaoTalk sender endpoint offers a way for you to manage your KakaoTalk senders that can be used with the Conversation API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/kakaotalk/senders","summary":"List all senders in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_listsenders_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders","summary":"Create sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_createsender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","summary":"Get sender for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_getsender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","summary":"Delete sender for project","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_deletesender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}","summary":"Updates a draft sender in project","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_updatesender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities","summary":"Lists activities on sender","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/changes","summary":"Delete pending or rejected changes to a sender","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_deletechanges_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/comments","summary":"Creates a comment for a sender in project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_createcomment_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/register","summary":"Register sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_registersender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify","summary":"Verify sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-senders/kakaotalksenderscontroller_verifysender_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"KakaoTalk Templates","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates","items":[{"label":"List all templates in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1","metadata":{"seo":{"title":"List all templates in project","description":"Returns a paginated list of templates for the specified project. If no page token is supplied then the first 50 templates are returned in alphabetical order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_listTemplates_v1","name":"List all templates in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all templates in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of templates for the specified project. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" templates are returned in alphabetical order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filterStates","in":"query","schemaId":"schema_977","description":"Optionally query for template by states."},{"name":"filterStatuses","in":"query","schemaId":"schema_978","description":"Optionally query for template by statuses."},{"name":"pageSize","in":"query","schemaId":"schema_949","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"templateName","in":"query","schemaId":"schema_922","description":"Optionally query for template by name. Will return all templates with names that begin with the query string."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"filterStates","in":"query","required":false,"schemaId":"schema_977"},{"name":"filterStatuses","in":"query","required":false,"schemaId":"schema_978"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_949"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"templateName","in":"query","required":false,"schemaId":"schema_922"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates","href":"kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1","openApiOperationId":"KakaotalkTemplatesController_listTemplates_v1","summary":"List all templates in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of templates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkTemplateListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/template_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/template_not_found-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkTemplateListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/template_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/template_not_found-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates"},{"label":"Create a template in project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1","metadata":{"seo":{"title":"Create a template in project","description":"Creates a new template with the request data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_createTemplate_v1","name":"Create a template in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a template in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a new template with the request data.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full"]}},"schemaId":"components/schemas/KakaotalkInputTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody","description":"Template data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KakaotalkInputTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full"]}},"responseCodes":["201","400","401","404","409","424","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates","href":"kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1","openApiOperationId":"KakaotalkTemplatesController_createTemplate_v1","summary":"Create a template in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/KakaotalkInputTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/template_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/invalid_payload-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/template_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/invalid_payload-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/409/content/application~1json/examples/template_exists-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/409/content/application~1json/examples/template_exists-0"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-2"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/template_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/invalid_payload-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/template_invalid_category_code-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/invalid_payload-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/409/content/application~1json/examples/template_exists-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/409/content/application~1json/examples/template_exists-0"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"KakaoTalk Template received a comment","description":"\n        Callback sent when a comment is placed on a template.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_979","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_979","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_979","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"KakaoTalk Template approved","description":"\n        Callback sent when a template is approved.\n        ","callbackName":"Approved","callbackId":"Approved/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_980","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_980","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Approved/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_980","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"KakaoTalk Template rejected","description":"\n        Callback sent when a template is rejected.\n        ","callbackName":"Rejected","callbackId":"Rejected/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_981","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_981","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Rejected/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_981","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates"},{"label":"Get template in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_get_v1","metadata":{"seo":{"title":"Get template in project","description":"Returns a template for a project, with the specified name and language."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_get_v1","name":"Get template in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a template for a project, with the specified name and language.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","href":"kakaotalk-templates/kakaotalktemplatescontroller_get_v1","openApiOperationId":"KakaotalkTemplatesController_get_v1","summary":"Get template in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/template_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/template_not_found-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/template_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/template_not_found-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}"},{"label":"Delete template for project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplate_v1","metadata":{"seo":{"title":"Delete template for project","description":"Delete template that matches the template code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_deleteTemplate_v1","name":"Delete template for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Delete template that matches the template code.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","href":"kakaotalk-templates/kakaotalktemplatescontroller_deletetemplate_v1","openApiOperationId":"KakaotalkTemplatesController_deleteTemplate_v1","summary":"Delete template for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Template deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/sender_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/sender_not_found-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/sender_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/template_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/sender_not_found-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}"},{"label":"Update a template in project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1","metadata":{"seo":{"title":"Update a template in project","description":"Updates an existing template with the request data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_updateTemplate_v1","name":"Update a template in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a template in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Updates an existing template with the request data.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputUpdateTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full"]}},"schemaId":"components/schemas/KakaotalkInputUpdateTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody","description":"Updating data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KakaotalkInputUpdateTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full"]}},"responseCodes":["200","400","401","404","409","424","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","href":"kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1","openApiOperationId":"KakaotalkTemplatesController_updateTemplate_v1","summary":"Update a template in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/KakaotalkInputUpdateTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KakaotalkInputUpdateTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/template_invalid_category_code-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/template_invalid_category_code-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/template_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/template_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2"]},{"code":"424","description":"FailedDependency","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/template_invalid_category_code-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/template_invalid_category_code-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/template_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/template_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_exists-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2"]}}},{"code":"424","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}"},{"label":"Lists activities on project template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on project template","description":"Paginated list of activities for a template. Ordered from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_listActivities_v1","name":"Lists activities on project template","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on project template","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Paginated list of activities for a template. Ordered from the most recent one to the oldest one.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/activities","href":"kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1","openApiOperationId":"KakaotalkTemplatesController_listActivities_v1","summary":"Lists activities on project template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/KakaotalkTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KakaotalkTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkTemplateNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/activities"},{"label":"Delete template draft for project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplatedraft_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplatedraft_v1","metadata":{"seo":{"title":"Delete template draft for project","description":"Delete a template draft."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_deleteTemplateDraft_v1","name":"Delete template draft for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template draft for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n      Delete a template draft.\n      \n      Please note that it is only possible to delete templates that have not yet been submitted to KakaoTalk."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/changes","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","409","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/changes","href":"kakaotalk-templates/kakaotalktemplatescontroller_deletetemplatedraft_v1","openApiOperationId":"KakaotalkTemplatesController_deleteTemplateDraft_v1","summary":"Delete template draft for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Template draft deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/409/content/application~1json/examples/template_not_deletable-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/409/content/application~1json/examples/template_not_deletable-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/409/content/application~1json/examples/template_not_deletable-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/409/content/application~1json/examples/template_not_deletable-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplatedraft_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/changes"},{"label":"Creates a comment for a template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1","metadata":{"seo":{"title":"Creates a comment for a template","description":"Creates a comment for a template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"KakaotalkTemplatesController_createComment_v1","name":"Creates a comment for a template","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for a template","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for a template.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"plusFriendId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"templateCode","in":"path","schemaId":"schema_922","description":"The unique name of the template.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"plusFriendId","in":"path","required":true,"schemaId":"schema_922"},{"name":"templateCode","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","500"],"pointer":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/comments","href":"kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1","openApiOperationId":"KakaotalkTemplatesController_createComment_v1","summary":"Creates a comment for a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for a template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KakaotalkCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2","paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/comments"}],"content":{"contentType":"group","meta":{"name":"KakaoTalk Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KakaoTalk Templates","showPageActions":true},{"nodeType":"markdoc","content":"The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk templates that can be used with the Conversation API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates","summary":"List all templates in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_listtemplates_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates","summary":"Create a template in project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_createtemplate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","summary":"Get template in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_get_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","summary":"Delete template for project","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}","summary":"Update a template in project","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_updatetemplate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/activities","summary":"Lists activities on project template","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/changes","summary":"Delete template draft for project","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_deletetemplatedraft_v1","deprecated":false},{"title":"/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates/{templateCode}/comments","summary":"Creates a comment for a template","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/kakaotalk-templates/kakaotalktemplatescontroller_createcomment_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"Conversation","content":null},{"type":"group","label":"Conversation","link":"/docs/provisioning-api/api-reference/provisioning-api/conversation","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/conversation","items":[{"label":"Get Instagram channel information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationinstagramcontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationinstagramcontroller_get_v1","metadata":{"seo":{"title":"Get Instagram channel information","description":"Returns the information for an Instagram channel linked to a Conversation API App."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConversationInstagramController_get_v1","name":"Get Instagram channel information","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Instagram channel information","badges":[{"name":"Closed Beta","color":"red","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n      Returns the information for an Instagram channel linked to a Conversation API App.\n      "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"conversationAppId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the app. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/convapi/apps"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/instagram","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/instagram","href":"conversation/conversationinstagramcontroller_get_v1","openApiOperationId":"ConversationInstagramController_get_v1","summary":"Get Instagram channel information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Instagram information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationInstagramInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/200/content/application~1json/examples/example"]}},"schemaId":"components/schemas/ConversationInstagramInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/200/content/application~1json/examples/example"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_no_instagram_channel-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_no_instagram_channel-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/internal_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/internal_error-1"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConversationInstagramInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/200/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationInstagramInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/200/content/application~1json/examples/example"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_no_instagram_channel-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_no_instagram_channel-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/internal_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/internal_error-1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/conversationinstagramcontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"httpPath":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/instagram"},{"label":"Get Facebook Messenger channel information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationmessengercontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationmessengercontroller_get_v1","metadata":{"seo":{"title":"Get Facebook Messenger channel information","description":"Returns the information for a Facebook Messenger channel linked to a Conversation API App."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConversationMessengerController_get_v1","name":"Get Facebook Messenger channel information","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Facebook Messenger channel information","badges":[{"name":"Closed Beta","color":"red","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns the information for a Facebook Messenger channel linked to a Conversation API App.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"conversationAppId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the app. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/convapi/apps"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/messenger","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/messenger","href":"conversation/conversationmessengercontroller_get_v1","openApiOperationId":"ConversationMessengerController_get_v1","summary":"Get Facebook Messenger channel information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Facebook Messenger information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationMessengerInfoDto"}},"schemaId":"components/schemas/ConversationMessengerInfoDto"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_no_messenger_channel-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_no_messenger_channel-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/internal_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/internal_error-1"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConversationMessengerInfoDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationMessengerInfoDto"}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_no_messenger_channel-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_no_messenger_channel-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/internal_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/facebook_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/internal_error-1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/conversationmessengercontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"httpPath":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/messenger"},{"label":"Get Telegram Bot channel information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationtelegramcontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationtelegramcontroller_get_v1","metadata":{"seo":{"title":"Get Telegram Bot channel information","description":"Returns the information for a Telegram Bot channel linked to a Conversation API App."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConversationTelegramController_get_v1","name":"Get Telegram Bot channel information","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Telegram Bot channel information","badges":[{"name":"Closed Beta","color":"red","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns the information for a Telegram Bot channel linked to a Conversation API App.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"conversationAppId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the app. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/convapi/apps"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram","href":"conversation/conversationtelegramcontroller_get_v1","openApiOperationId":"ConversationTelegramController_get_v1","summary":"Get Telegram Bot channel information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Telegram Bot information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationTelegramBotInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/200/content/application~1json/examples/example"]}},"schemaId":"components/schemas/ConversationTelegramBotInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/200/content/application~1json/examples/example"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_no_telegram_channel-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_no_telegram_channel-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/telegram_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/internal_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/telegram_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/internal_error-1"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConversationTelegramBotInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/200/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationTelegramBotInfoDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/200/content/application~1json/examples/example"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_no_telegram_channel-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_no_telegram_channel-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/telegram_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/internal_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/telegram_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/internal_error-1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/conversationtelegramcontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"httpPath":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram"},{"label":"Get Viber Bot channel information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationvibercontroller_get_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/conversation/conversationvibercontroller_get_v1","metadata":{"seo":{"title":"Get Viber Bot channel information","description":"Returns the information for a Viber Bot channel linked to a Conversation API App."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConversationViberController_get_v1","name":"Get Viber Bot channel information","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Viber Bot channel information","badges":[{"name":"Closed Beta","color":"red","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns the information for a Viber Bot channel linked to a Conversation API App.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"conversationAppId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the app. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/convapi/apps"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/viber","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"conversationAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/viber","href":"conversation/conversationvibercontroller_get_v1","openApiOperationId":"ConversationViberController_get_v1","summary":"Get Viber Bot channel information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Viber Bot information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationViberBotInfoDto"}},"schemaId":"components/schemas/ConversationViberBotInfoDto"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_no_viber_channel-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_no_viber_channel-1"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/viber_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/internal_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/viber_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/internal_error-1"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConversationViberBotInfoDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationViberBotInfoDto"}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_no_viber_channel-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_not_found-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_no_viber_channel-1"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/viber_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/internal_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/viber_api_error-0","paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/internal_error-1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversation/conversationvibercontroller_get_v1"}],"panels":[]}]},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"httpPath":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/viber"}],"content":{"contentType":"group","meta":{"name":"Conversation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversation","showPageActions":true},{"nodeType":"markdoc","content":"The Conversation endpoints allows you to retrieve information about channels used with Conversation API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/instagram","summary":"Get Instagram channel information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"link":"/conversation/conversationinstagramcontroller_get_v1","deprecated":false},{"title":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/messenger","summary":"Get Facebook Messenger channel information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"link":"/conversation/conversationmessengercontroller_get_v1","deprecated":false},{"title":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram","summary":"Get Telegram Bot channel information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"link":"/conversation/conversationtelegramcontroller_get_v1","deprecated":false},{"title":"/v1/projects/{projectId}/conversation/apps/{conversationAppId}/viber","summary":"Get Viber Bot channel information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Closed Beta","color":"red","position":"after"}],"link":"/conversation/conversationvibercontroller_get_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"RCS","content":null},{"type":"group","label":"RCS Accounts","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts","items":[{"label":"Lists activities on account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts/rcsaccountscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts/rcsaccountscontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on account","description":"Paginated list of activities for account. Ordered from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsAccountsController_listActivities_v1","name":"Lists activities on account","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on account","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Paginated list of activities for account. Ordered from the most recent one to the oldest one.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/rcs/activities","href":"rcs-accounts/rcsaccountscontroller_listactivities_v1","openApiOperationId":"RcsAccountsController_listActivities_v1","summary":"Lists activities on account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsAccountNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-accounts/rcsaccountscontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/activities"},{"label":"Creates a comment for an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts/rcsaccountscontroller_createcomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-accounts/rcsaccountscontroller_createcomment_v1","metadata":{"seo":{"title":"Creates a comment for an account","description":"Creates a comment for an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsAccountsController_createComment_v1","name":"Creates a comment for an account","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for an account","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for an account.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/rcs/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","500"],"pointer":"/v1/projects/{projectId}/rcs/comments","href":"rcs-accounts/rcsaccountscontroller_createcomment_v1","openApiOperationId":"RcsAccountsController_createComment_v1","summary":"Creates a comment for an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for an account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Comment on account","description":"\n        Received when a comment has been added to the account.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_982","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_982","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_982","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-accounts/rcsaccountscontroller_createcomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/comments"}],"content":{"contentType":"group","meta":{"name":"RCS Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RCS Accounts","showPageActions":true},{"nodeType":"markdoc","content":"The RCS endpoint offers you a way to manage your RCS accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/rcs/activities","summary":"Lists activities on account","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-accounts/rcsaccountscontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/comments","summary":"Creates a comment for an account","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-accounts/rcsaccountscontroller_createcomment_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"RCS Questionnaire","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-questionnaire","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-questionnaire","items":[{"label":"Get questionnaire questions for project and use case","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-questionnaire/rcsquestionnairecontroller_getquestions_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-questionnaire/rcsquestionnairecontroller_getquestions_v1","metadata":{"seo":{"title":"Get questionnaire questions for project and use case","description":"Returns questionnaire questions for a use case."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsQuestionnaireController_getQuestions_v1","name":"Get questionnaire questions for project and use case","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get questionnaire questions for project and use case","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns questionnaire questions for a use case.\n\n    The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"useCase","in":"path","schemaId":"schema_983","description":"Use case.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_984","description":"Optional query for sender countries."},{"name":"usQuestionnaireBrandCampaignVersion","in":"query","schemaId":"schema_985","description":"Optional query parameter to specify the US questionnaire brand campaign version."},{"name":"usQuestionnaireVersion","in":"query","schemaId":"schema_986","description":"Optional query parameter to specify the US questionnaire version."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/questionnaire/{useCase}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"useCase","in":"path","required":true,"schemaId":"components/schemas/RcsSenderUseCasesEnum"}],"query":[{"name":"countries","in":"query","required":false,"schemaId":"schema_984"},{"name":"usQuestionnaireBrandCampaignVersion","in":"query","required":false,"schemaId":"components/schemas/RcsUsQuestionnaireBrandCampaignVersionsEnum"},{"name":"usQuestionnaireVersion","in":"query","required":false,"schemaId":"components/schemas/RcsUsQuestionnaireVersionsEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/projects/{projectId}/rcs/questionnaire/{useCase}","href":"rcs-questionnaire/rcsquestionnairecontroller_getquestions_v1","openApiOperationId":"RcsQuestionnaireController_getQuestions_v1","summary":"Get questionnaire questions for project and use case"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Questionnaire questions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDetailsQuestionnaireBaseDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/deprecatedUsQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/gbFrQuestionnaire"]}},"schemaId":"components/schemas/RcsSenderDetailsQuestionnaireBaseDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/deprecatedUsQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/gbFrQuestionnaire"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_use_case-0","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_country-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_use_case-0","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_country-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsSenderDetailsQuestionnaireBaseDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/deprecatedUsQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/gbFrQuestionnaire"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDetailsQuestionnaireBaseDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPublicQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPrivateQuestionnaireResponse","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/deprecatedUsQuestionnaire","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/gbFrQuestionnaire"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_use_case-0","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_country-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_use_case-0","paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_country-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-questionnaire/rcsquestionnairecontroller_getquestions_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/questionnaire/{useCase}"}],"content":{"contentType":"group","meta":{"name":"RCS Questionnaire"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RCS Questionnaire","showPageActions":true},{"nodeType":"markdoc","content":"Manage your RCS questionnaires."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/rcs/questionnaire/{useCase}","summary":"Get questionnaire questions for project and use case","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-questionnaire/rcsquestionnairecontroller_getquestions_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"RCS Senders","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders","items":[{"label":"List all senders in project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_listsenders_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_listsenders_v1","metadata":{"seo":{"title":"List all senders in project","description":"Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_listSenders_v1","name":"List all senders in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all senders in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of senders for the specified project. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"filterConversationApiAppId","in":"query","schemaId":"schema_922","description":"Optional query for sender by Conversation API app id."},{"name":"filterSenderIds","in":"query","schemaId":"schema_922","description":"Optional query for sender by sender ids."},{"name":"filterSenderName","in":"query","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional query for sender by name. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter instead"},"children":[]}]}]}],"deprecated":true},{"name":"filterStates","in":"query","schemaId":"schema_987","description":"Optionally query for sender by states."},{"name":"search","in":"query","schemaId":"schema_922","description":"Search term to filter senders (partial match, case-insensitive)."},{"name":"sortColumn","in":"query","schemaId":"schema_988","description":"Optional query for sender sort column."},{"name":"sortDirection","in":"query","schemaId":"schema_989","description":"Optional query for sender sort direction."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"filterConversationApiAppId","in":"query","required":false,"schemaId":"schema_922"},{"name":"filterSenderIds","in":"query","required":false,"schemaId":"schema_922"},{"name":"filterSenderName","in":"query","required":false,"schemaId":"schema_922"},{"name":"filterStates","in":"query","required":false,"schemaId":"schema_987"},{"name":"search","in":"query","required":false,"schemaId":"schema_922"},{"name":"sortColumn","in":"query","required":false,"schemaId":"components/schemas/RcsSenderSortColumnsEnum"},{"name":"sortDirection","in":"query","required":false,"schemaId":"components/schemas/RcsSortDirectionsEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders","href":"rcs-senders/rcssenderscontroller_listsenders_v1","openApiOperationId":"RcsSendersController_listSenders_v1","summary":"List all senders in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of senders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_listsenders_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders"},{"label":"Create sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_createsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_createsender_v1","metadata":{"seo":{"title":"Create sender for project","description":"Returns a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_createSender_v1","name":"Create sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RcsSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/RcsSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody","description":"Sender data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/rcs/senders","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RcsSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","403","404","409","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders","href":"rcs-senders/rcssenderscontroller_createsender_v1","openApiOperationId":"RcsSendersController_createSender_v1","summary":"Create sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/RcsSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RcsSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input"]}},"examples":[{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_payload-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_google_agent-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/add_test_number_invalid-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_payload-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_google_agent-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/add_test_number_invalid-4"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_webhook_incorrect_secret-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_webhook_incorrect_secret-1"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_payload-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_google_agent-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/add_test_number_invalid-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_payload-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_google_agent-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/add_test_number_invalid-4"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_webhook_incorrect_secret-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_webhook_incorrect_secret-1"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender status updated","description":"\n        Received when a Sender status is updated.\n        ","callbackName":"StatusUpdate","callbackId":"StatusUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_990","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_990","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"StatusUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_990","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Sender operator status updated","description":"\n        Received when sender operator status is updated.\n        ","callbackName":"OperatorStatusUpdate","callbackId":"OperatorStatusUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_991","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_991","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"OperatorStatusUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_991","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Comment on sender","description":"\n        Received when a comment has been added to the sender.\n        ","callbackName":"Comment","callbackId":"Comment/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_992","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_992","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"Comment/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_992","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#webhooks.target}","summary":"Brand registration process status updated","description":"\n        Received when the registration process status is updated for a brand associated with the sender.\n        ","callbackName":"BrandOrderStatusUpdate","callbackId":"BrandOrderStatusUpdate/post","contentChildren":[{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sinch-webhook-signature","in":"header","schemaId":"schema_925","example":"Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8="},{"name":"x-sinch-webhook-signature-algorithm","in":"header","schemaId":"schema_926","example":"HmacSHA256"},{"name":"x-sinch-webhook-signature-nonce","in":"header","schemaId":"schema_922","example":"01EAW2BNWCG9DC13RS582V0ZQ3"},{"name":"x-sinch-webhook-signature-timestamp","in":"header","schemaId":"schema_927","example":"1592227387"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_993","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_993","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to callback will be ignored. The call will retry if unsuccessful."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/responses"}]},"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"BrandOrderStatusUpdate/post","path":"{$request.body#webhooks.target}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_993","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody/content/application~1json/example"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_createsender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders"},{"label":"Get sender for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_getsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_getsender_v1","metadata":{"seo":{"title":"Get sender for project","description":"Returns a sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_getSender_v1","name":"Get sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns a sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/senders/{senderId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}","href":"rcs-senders/rcssenderscontroller_getsender_v1","openApiOperationId":"RcsSendersController_getSender_v1","summary":"Get sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newInTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newLaunching","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunchBrand","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/inTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/preparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/launching"]}},"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newInTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newLaunching","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunchBrand","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/inTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/preparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/launching"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newInTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newLaunching","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunchBrand","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/inTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/preparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/launching"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newInTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newLaunching","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunchBrand","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/inTest","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/preparingLaunch","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/launching"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_getsender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}"},{"label":"Update sender for project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_updatesender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_updatesender_v1","metadata":{"seo":{"title":"Update sender for project","description":"Returns updated sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_updateSender_v1","name":"Update sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns updated sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"usQuestionnaireVersion","in":"query","schemaId":"schema_986","description":"Optional query parameter to specify the US questionnaire version for the update."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RcsUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/RcsUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody","description":"Sender data update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/rcs/senders/{senderId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"usQuestionnaireVersion","in":"query","required":false,"schemaId":"components/schemas/RcsUsQuestionnaireVersionsEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RcsUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}","href":"rcs-senders/rcssenderscontroller_updatesender_v1","openApiOperationId":"RcsSendersController_updateSender_v1","summary":"Update sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/RcsUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RcsUpdateSenderInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/fields_not_updatable-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_google_agent-5","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/add_test_number_invalid-6","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-7"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/fields_not_updatable-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_google_agent-5","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/add_test_number_invalid-6","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-7"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/rbm_resources_not_found-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/rbm_resources_not_found-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/fields_not_updatable-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_google_agent-5","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/add_test_number_invalid-6","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-7"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/fields_not_updatable-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_google_agent-5","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/add_test_number_invalid-6","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-7"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/rbm_resources_not_found-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/rbm_resources_not_found-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_updatesender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}"},{"label":"Lists activities on sender","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_listactivities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_listactivities_v1","metadata":{"seo":{"title":"Lists activities on sender","description":"Paginated list of activities for sender. Ordered from the most recent one to the oldest one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_listActivities_v1","name":"Lists activities on sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists activities on sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Paginated list of activities for sender. Ordered from the most recent one to the oldest one.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."},{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/activities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/activities","href":"rcs-senders/rcssenderscontroller_listactivities_v1","openApiOperationId":"RcsSendersController_listActivities_v1","summary":"Lists activities on sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recent activities on sender","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_id_format-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_id_format-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderNotificationListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_id_format-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_id_format-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_listactivities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/activities"},{"label":"Creates a comment for a sender in project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_createsendercomment_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_createsendercomment_v1","metadata":{"seo":{"title":"Creates a comment for a sender in project","description":"Creates a comment for a sender in project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_createSenderComment_v1","name":"Creates a comment for a sender in project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a comment for a sender in project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Creates a comment for a sender in project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody","description":"Comment data."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/comments","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["201","400","401","404","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/comments","href":"rcs-senders/rcssenderscontroller_createsendercomment_v1","openApiOperationId":"RcsSendersController_createSenderComment_v1","summary":"Creates a comment for a sender in project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WhatsappCommentInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created comment for a sender in project","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_id_format-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_id_format-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsCommentDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_id_format-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_id_format-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_createsendercomment_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/comments"},{"label":"Begin launch process for sender","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_launchsender_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_launchsender_v1","metadata":{"seo":{"title":"Begin launch process for sender","description":"Begins launch process for a sender in project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_launchSender_v1","name":"Begin launch process for sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Begin launch process for sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Begins launch process for a sender in project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements to begin launch process:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All required questionnaire answers must be provided;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For senders using the US V2 questionnaire, the verification phone number is required;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country-specific questionnaire answers are required when applicable to the sender's countries;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Countries ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must have at least one (1) value;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one contact phone number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.brand.phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a contact email ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.brand.emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is required, but both are recommended;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A brand banner url ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.brand.bannerUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must be defined;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A brand logo url ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.brand.logoUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must be defined;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A privacy policy url ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.brand.privacyPolicyUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must be defined;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terms of service url ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.brand.termsOfServiceUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must be defined;"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no video URI was provided in questionnaire, Sender will go into PENDING_LAUNCH while a video is added by Service Implementation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/launch","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","412","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/launch","href":"rcs-senders/rcssenderscontroller_launchsender_v1","openApiOperationId":"RcsSendersController_launchSender_v1","summary":"Begin launch process for sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Launched sender in project","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newLaunchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchBrandResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/launchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/preparingLaunchResponse"]}},"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newLaunchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchBrandResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/launchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/preparingLaunchResponse"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/verification_suspended_in_gmb-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/verification_suspended_in_gmb-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_agent_state-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_verification_state-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_agent_state-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_verification_state-1"]},{"code":"412","description":"PreconditionFailed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/412/content/application~1json/examples/launch_precondition_failed-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/412/content/application~1json/examples/launch_precondition_failed-0"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newLaunchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchBrandResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/launchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/preparingLaunchResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsSenderDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newLaunchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchBrandResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/launchingResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/preparingLaunchResponse"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/verification_suspended_in_gmb-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/verification_suspended_in_gmb-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_id_format-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"]}}},{"code":"409","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_agent_state-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_verification_state-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_agent_state-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_verification_state-1"]}}},{"code":"412","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/412/content/application~1json/examples/launch_precondition_failed-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/412/content/application~1json/examples/launch_precondition_failed-0"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_launchsender_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/launch"},{"label":"Add test numbers to sender for project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_addtestnumbers_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_addtestnumbers_v1","metadata":{"seo":{"title":"Add test numbers to sender for project","description":"Returns updated test number states of sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_addTestNumbers_v1","name":"Add test numbers to sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add test numbers to sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns updated test number states of sender for a project.\n\n    Please note that if you re-add verified number, state will be changed to unverified and an invite to become a tester will be sent again.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RcsTestNumbersInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input"]}},"schemaId":"components/schemas/RcsTestNumbersInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input"],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody","description":"Test numbers to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RcsTestNumbersInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers","href":"rcs-senders/rcssenderscontroller_addtestnumbers_v1","openApiOperationId":"RcsSendersController_addTestNumbers_v1","summary":"Add test numbers to sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/RcsTestNumbersInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RcsTestNumbersInputDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test number states","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumbersDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsTestNumbersDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/no_google_supplier-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/add_test_number_invalid-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/no_google_supplier-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/add_test_number_invalid-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-4"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/user_cannot_be_reached-4"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/user_cannot_be_reached-4"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsTestNumbersDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumbersDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/no_google_supplier-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/add_test_number_invalid-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_input-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/no_google_supplier-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/add_test_number_invalid-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-4"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/user_cannot_be_reached-4"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/user_cannot_be_reached-4"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_addtestnumbers_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers"},{"label":"Gets test number state of the sender for the project.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_gettestnumberstate_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_gettestnumberstate_v1","metadata":{"seo":{"title":"Gets test number state of the sender for the project.","description":"Returns test number state of the sender for the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_getTestNumberState_v1","name":"Gets test number state of the sender for the project.","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets test number state of the sender for the project.","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns test number state of the sender for the project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","required":true},{"name":"testNumber","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}","href":"rcs-senders/rcssenderscontroller_gettestnumberstate_v1","openApiOperationId":"RcsSendersController_getTestNumberState_v1","summary":"Gets test number state of the sender for the project."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test number state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/400/content/application~1json/examples/no_google_supplier-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/400/content/application~1json/examples/no_google_supplier-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-2"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/newResponse","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/400/content/application~1json/examples/no_google_supplier-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/400/content/application~1json/examples/no_google_supplier-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/project_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/sender_not_found-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-2"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_gettestnumberstate_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}"},{"label":"Deletes a test number for the sender","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_deletetestnumber_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_deletetestnumber_v1","metadata":{"seo":{"title":"Deletes a test number for the sender","description":"Deletes a test number for the sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_deleteTestNumber_v1","name":"Deletes a test number for the sender","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a test number for the sender","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Deletes a test number for the sender.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"testNumber","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting parameter is '+12223334444'."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}","href":"rcs-senders/rcssenderscontroller_deletetestnumber_v1","openApiOperationId":"RcsSendersController_deleteTestNumber_v1","summary":"Deletes a test number for the sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Test number deleted"},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_deletetestnumber_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}"},{"label":"Get test number capabilities of sender for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_gettestnumbercapabilities_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_gettestnumbercapabilities_v1","metadata":{"seo":{"title":"Get test number capabilities of sender for project","description":"Returns test number capabilities of sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_getTestNumberCapabilities_v1","name":"Get test number capabilities of sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get test number capabilities of sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Returns test number capabilities of sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"testNumber","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting parameter is '+12223334444'."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities","href":"rcs-senders/rcssenderscontroller_gettestnumbercapabilities_v1","openApiOperationId":"RcsSendersController_getTestNumberCapabilities_v1","summary":"Get test number capabilities of sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"test number capabilities","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumberCapabilitiesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsTestNumberCapabilitiesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/no_google_supplier-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/no_google_supplier-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/403/content/application~1json/examples/wrong_supplier_configuration-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/403/content/application~1json/examples/wrong_supplier_configuration-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/looking_up_the_rbm_agent-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_has_not_accepted_invite-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_cannot_be_reached-5"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/looking_up_the_rbm_agent-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_has_not_accepted_invite-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_cannot_be_reached-5"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsTestNumberCapabilitiesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumberCapabilitiesDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/no_google_supplier-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/no_google_supplier-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"403","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/403/content/application~1json/examples/wrong_supplier_configuration-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/403/content/application~1json/examples/wrong_supplier_configuration-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/looking_up_the_rbm_agent-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_has_not_accepted_invite-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_cannot_be_reached-5"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/looking_up_the_rbm_agent-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_has_not_accepted_invite-4","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_cannot_be_reached-5"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_gettestnumbercapabilities_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities"},{"label":"Resend an invite to test number of sender for project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_retrytestnumber_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/rcs-senders/rcssenderscontroller_retrytestnumber_v1","metadata":{"seo":{"title":"Resend an invite to test number of sender for project","description":"Resend an invite and returns state for test number of sender for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RcsSendersController_retryTestNumber_v1","name":"Resend an invite to test number of sender for project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend an invite to test number of sender for project","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Resend an invite and returns state for test number of sender for a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"senderId","in":"path","schemaId":"schema_922","description":"The unique ID of the sender.","required":true},{"name":"testNumber","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting parameter is '+12223334444'."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"senderId","in":"path","required":true,"schemaId":"schema_922"},{"name":"testNumber","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry","href":"rcs-senders/rcssenderscontroller_retrytestnumber_v1","openApiOperationId":"RcsSendersController_retryTestNumber_v1","summary":"Resend an invite to test number of sender for project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"test number state","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/add_test_number_invalid-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/add_test_number_invalid-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-3"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"]},{"code":"429","description":"TooManyRequests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcsTestNumberStateDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/add_test_number_invalid-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_id_format-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/no_google_supplier-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/add_test_number_invalid-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-3"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/sender_not_found-0","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2","paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"]}}},{"code":"429","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rcs-senders/rcssenderscontroller_retrytestnumber_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry"}],"content":{"contentType":"group","meta":{"name":"RCS Senders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RCS Senders","showPageActions":true},{"nodeType":"markdoc","content":"The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/rcs/senders","summary":"List all senders in project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_listsenders_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders","summary":"Create sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_createsender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}","summary":"Get sender for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_getsender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}","summary":"Update sender for project","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_updatesender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/activities","summary":"Lists activities on sender","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_listactivities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/comments","summary":"Creates a comment for a sender in project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_createsendercomment_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/launch","summary":"Begin launch process for sender","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_launchsender_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers","summary":"Add test numbers to sender for project","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_addtestnumbers_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}","summary":"Gets test number state of the sender for the project.","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_gettestnumberstate_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}","summary":"Deletes a test number for the sender","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_deletetestnumber_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities","summary":"Get test number capabilities of sender for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_gettestnumbercapabilities_v1","deprecated":false},{"title":"/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry","summary":"Resend an invite to test number of sender for project","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/rcs-senders/rcssenderscontroller_retrytestnumber_v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"SMS","content":null},{"type":"group","label":"SMS Apps","link":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps","items":[{"label":"List all sms apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_listsmsapps_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_listsmsapps_v1","metadata":{"seo":{"title":"List all sms apps","description":"Returns a paginated list of all sms apps. If no page token is supplied then the first 50 will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SmsSmsAppsController_listSmsApps_v1","name":"List all sms apps","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all sms apps","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of all sms apps. If no page token is supplied then the first "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_934","description":"The page size requested."},{"name":"pageToken","in":"query","schemaId":"schema_922","description":"The page token if retrieving the next page from a previous query."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/sms/smsApps","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[{"name":"pageSize","in":"query","required":false,"schemaId":"schema_934"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_922"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/sms/smsApps","href":"sms-apps/smssmsappscontroller_listsmsapps_v1","openApiOperationId":"SmsSmsAppsController_listSmsApps_v1","summary":"List all sms apps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of sms apps","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SmsSmsAppListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_id_format-2"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_id_format-2"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/404/content/application~1json/examples/sms_service_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/404/content/application~1json/examples/sms_service_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SmsSmsAppListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppListDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_id_format-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_token-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_size-1","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_id_format-2"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/404/content/application~1json/examples/sms_service_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/404/content/application~1json/examples/sms_service_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-apps/smssmsappscontroller_listsmsapps_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/sms/smsApps"},{"label":"Create an sms app","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_createsmsapp_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_createsmsapp_v1","metadata":{"seo":{"title":"Create an sms app","description":"Creates a new sms app for the given project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SmsSmsAppsController_createSmsApp_v1","name":"Create an sms app","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an sms app","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new sms app for the given project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SmsInputSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId"]}},"schemaId":"components/schemas/SmsInputSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId"],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody","description":"Sms app to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/sms/smsApps","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SmsInputSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId"]}},"responseCodes":["201","400","401","500"],"pointer":"/v1/projects/{projectId}/sms/smsApps","href":"sms-apps/smssmsappscontroller_createsmsapp_v1","openApiOperationId":"SmsSmsAppsController_createSmsApp_v1","summary":"Create an sms app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/SmsInputSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SmsInputSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Newly created sms app","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/201/content/application~1json/examples/europe"]}},"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/201/content/application~1json/examples/europe"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_payload-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_payload-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/201/content/application~1json/examples/europe"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/201/content/application~1json/examples/europe"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_payload-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_payload-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-apps/smssmsappscontroller_createsmsapp_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/sms/smsApps"},{"label":"Get SMS app by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_getsmsapp_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_getsmsapp_v1","metadata":{"seo":{"title":"Get SMS app by ID","description":"Retrieves a single SMS app by its ID within a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SmsSmsAppsController_getSmsApp_v1","name":"Get SMS app by ID","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SMS app by ID","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\n    Retrieves a single SMS app by its ID within a project.\n    "},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"smsAppId","in":"path","schemaId":"schema_922","description":"Sms App id.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"smsAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","href":"sms-apps/smssmsappscontroller_getsmsapp_v1","openApiOperationId":"SmsSmsAppsController_getSmsApp_v1","summary":"Get SMS app by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SMS app details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/200/content/application~1json/examples/response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-1"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/404/content/application~1json/examples/sms_app_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/404/content/application~1json/examples/sms_app_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-1"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/404/content/application~1json/examples/sms_app_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/404/content/application~1json/examples/sms_app_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-apps/smssmsappscontroller_getsmsapp_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}"},{"label":"Delete sms app","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_deletesmsapp_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_deletesmsapp_v1","metadata":{"seo":{"title":"Delete sms app","description":"Delete sms app"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SmsSmsAppsController_deleteSmsApp_v1","name":"Delete sms app","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete sms app","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"smsAppId","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"smsAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","500"],"pointer":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","href":"sms-apps/smssmsappscontroller_deletesmsapp_v1","openApiOperationId":"SmsSmsAppsController_deleteSmsApp_v1","summary":"Delete sms app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Sms app deleted."},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/404/content/application~1json/examples/sms_app_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/404/content/application~1json/examples/sms_app_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/404/content/application~1json/examples/sms_app_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/404/content/application~1json/examples/sms_app_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-apps/smssmsappscontroller_deletesmsapp_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}"},{"label":"Update an sms app","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_updatesmsapp_v1","routeSlug":"/docs/provisioning-api/api-reference/provisioning-api/sms-apps/smssmsappscontroller_updatesmsapp_v1","metadata":{"seo":{"title":"Update an sms app","description":"Updates the name of an existing sms app."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SmsSmsAppsController_updateSmsApp_v1","name":"Update an sms app","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an sms app","badges":[{"name":"GA","color":"green","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the name of an existing sms app."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"},{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"OAuth2Production","scopes":[],"type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_922","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the project. You can find this on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://dashboard.sinch.com/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"smsAppId","in":"path","schemaId":"schema_922","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SmsUpdateSmsAppDto"}},"schemaId":"components/schemas/SmsUpdateSmsAppDto","pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/requestBody","description":"Sms app fields to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"schemaId":"schema_922"},{"name":"smsAppId","in":"path","required":true,"schemaId":"schema_922"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"},{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"OAuth2Production","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SmsUpdateSmsAppDto"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","href":"sms-apps/smssmsappscontroller_updatesmsapp_v1","openApiOperationId":"SmsSmsAppsController_updateSmsApp_v1","summary":"Update an sms app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"schemaId":"components/schemas/SmsUpdateSmsAppDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SmsUpdateSmsAppDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated sms app","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/200/content/application~1json/examples/response"]},{"code":"400","description":"BadRequest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-1"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-1"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]},{"code":"404","description":"NotFound","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/404/content/application~1json/examples/sms_app_not_found-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/404/content/application~1json/examples/sms_app_not_found-0"]},{"code":"500","description":"InternalServerError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}},"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SmsSmsAppDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/invalid_input-0","paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-1"]}}},{"code":"401","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"]}}},{"code":"404","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/404/content/application~1json/examples/sms_app_not_found-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/404/content/application~1json/examples/sms_app_not_found-0"]}}},{"code":"500","schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/500/content/application~1json/examples/internal_error-0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookPapiErrorDto","exampleIds":["paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/500/content/application~1json/examples/internal_error-0"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sms-apps/smssmsappscontroller_updatesmsapp_v1"}],"panels":[]}]},"badges":[{"name":"GA","color":"green","position":"after"}],"httpPath":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}"}],"content":{"contentType":"group","meta":{"name":"SMS Apps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SMS Apps","showPageActions":true},{"nodeType":"markdoc","content":"The SMS apps endpoint allows you to create and manage your SMS apps."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/sms/smsApps","summary":"List all sms apps","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/sms-apps/smssmsappscontroller_listsmsapps_v1","deprecated":false},{"title":"/v1/projects/{projectId}/sms/smsApps","summary":"Create an sms app","prefix":{"name":"post","color":"post"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/sms-apps/smssmsappscontroller_createsmsapp_v1","deprecated":false},{"title":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","summary":"Get SMS app by ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/sms-apps/smssmsappscontroller_getsmsapp_v1","deprecated":false},{"title":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","summary":"Delete sms app","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/sms-apps/smssmsappscontroller_deletesmsapp_v1","deprecated":false},{"title":"/v1/projects/{projectId}/sms/smsApps/{smsAppId}","summary":"Update an sms app","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"GA","color":"green","position":"after"}],"link":"/sms-apps/smssmsappscontroller_updatesmsapp_v1","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/WebhookWebhookTriggersEnum":{"id":"components/schemas/WebhookWebhookTriggersEnum","kind":"json-schema","title":"WebhookWebhookTriggersEnum","data":{"type":"string","enum":["ALL","BUNDLE_DONE","KAKAOTALK_SENDER_ACTIVE","KAKAOTALK_SENDER_COMMENT_ADDED","KAKAOTALK_SENDER_INACTIVE","KAKAOTALK_SENDER_REJECTED","KAKAOTALK_TEMPLATE_APPROVED","KAKAOTALK_TEMPLATE_COMMENT_ADDED","KAKAOTALK_TEMPLATE_REJECTED","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED","RCS_SENDER_COMMENT_ADDED","RCS_SENDER_OPERATOR_STATUS_UPDATED","RCS_SENDER_STATUS_UPDATED","RCS_ACCOUNT_COMMENT_ADDED","WHATSAPP_ACCOUNT_COMMENT_ADDED","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED","WHATSAPP_ACCOUNT_ONBOARDED","WHATSAPP_ACCOUNT_PENDING_VERIFICATION","WHATSAPP_ACCOUNT_REJECTED","WHATSAPP_WABA_ACCOUNT_CHANGED","WHATSAPP_SENDER_ACTIVE","WHATSAPP_SENDER_COMMENT_ADDED","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED","WHATSAPP_SENDER_DELETED","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED","WHATSAPP_SENDER_ERROR","WHATSAPP_SENDER_INACTIVE","WHATSAPP_SENDER_PENDING_VERIFICATION","WHATSAPP_SENDER_QUALITY_RATING_CHANGED","WHATSAPP_SENDER_REJECTED","WHATSAPP_SENDER_USERNAME_UPDATED","WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE","WHATSAPP_TEMPLATE_CATEGORY_UPDATED","WHATSAPP_TEMPLATE_COMMENT_ADDED","WHATSAPP_TEMPLATE_DELETED","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED","WHATSAPP_TEMPLATE_REJECTED","WHATSAPP_TEMPLATE_STATUS_UPDATED"],"description":"List of triggers this webhook is triggered by."}},"components/schemas/WebhookWebhookDto":{"id":"components/schemas/WebhookWebhookDto","kind":"json-schema","title":"WebhookWebhookDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the webhook.","uniqueItems":false},"target":{"type":"string","description":"The target url where events will be sent to.","uniqueItems":false},"projectId":{"type":"string","description":"The project that this webhook belongs to.","uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BUNDLE_DONE":"Webhook event triggered when a bundle processing flow is completed.","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED":"Webhook event triggered when the RCS brand registration process status changes.","RCS_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS sender.","RCS_SENDER_OPERATOR_STATUS_UPDATED":"Webhook event triggered when an RCS sender operator status changes.","RCS_SENDER_STATUS_UPDATED":"Webhook event triggered when an RCS sender status changes.","RCS_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS account.","KAKAOTALK_SENDER_ACTIVE":"Webhook event triggered when a KakaoTalk sender becomes active.","KAKAOTALK_SENDER_INACTIVE":"Webhook event triggered when a KakaoTalk sender becomes inactive.","KAKAOTALK_SENDER_REJECTED":"Webhook event triggered when a KakaoTalk sender is rejected.","KAKAOTALK_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk sender.","KAKAOTALK_TEMPLATE_APPROVED":"Webhook event triggered when a KakaoTalk template is approved.","KAKAOTALK_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk template.","KAKAOTALK_TEMPLATE_REJECTED":"Webhook event triggered when a KakaoTalk template is rejected.","WHATSAPP_ACCOUNT_ONBOARDED":"Webhook event triggered when a WhatsApp account onboarding is completed.","WHATSAPP_ACCOUNT_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp account is pending verification.","WHATSAPP_ACCOUNT_REJECTED":"Webhook event triggered when a WhatsApp account is rejected.","WHATSAPP_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp account.","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp account daily messaging limit changes.","WHATSAPP_WABA_ACCOUNT_CHANGED":"Webhook event triggered when the linked WhatsApp Business Account changes.","WHATSAPP_SENDER_ACTIVE":"Webhook event triggered when a WhatsApp sender becomes active.","WHATSAPP_SENDER_INACTIVE":"Webhook event triggered when a WhatsApp sender becomes inactive.","WHATSAPP_SENDER_REJECTED":"Webhook event triggered when a WhatsApp sender is rejected.","WHATSAPP_SENDER_DELETED":"Webhook event triggered when a WhatsApp sender is deleted.","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED":"Webhook event triggered when a WhatsApp sender display name is updated.","WHATSAPP_SENDER_ERROR":"Webhook event triggered when a WhatsApp sender enters an error state.","WHATSAPP_SENDER_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp sender is pending verification.","WHATSAPP_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp sender.","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp sender daily messaging limit changes.","WHATSAPP_SENDER_QUALITY_RATING_CHANGED":"Webhook event triggered when a WhatsApp sender quality rating changes.","WHATSAPP_SENDER_USERNAME_UPDATED":"Webhook event triggered when a WhatsApp sender username is updated.","WHATSAPP_TEMPLATE_APPROVED":"Webhook event triggered when a WhatsApp template is approved.","WHATSAPP_TEMPLATE_REJECTED":"Webhook event triggered when a WhatsApp template is rejected.","WHATSAPP_TEMPLATE_DELETED":"Webhook event triggered when a WhatsApp template is deleted.","WHATSAPP_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp template.","WHATSAPP_TEMPLATE_STATUS_UPDATED":"Webhook event triggered when a WhatsApp template status changes.","WHATSAPP_TEMPLATE_CATEGORY_UPDATED":"Webhook event triggered when a WhatsApp template category changes.","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE":"Webhook event triggered when a future WhatsApp template category update is scheduled.","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED":"Webhook event triggered when a WhatsApp template quality score changes.","ALL":"Webhook event triggered for all supported events."},"uniqueItems":true,"description":"List of triggers this webhook is triggered by.","items":{"$ref":"#/components/schemas/WebhookWebhookTriggersEnum"}}},"required":["id","target","projectId","triggers"]}},"components/schemas/WebhookPapiErrorDto":{"id":"components/schemas/WebhookPapiErrorDto","kind":"json-schema","title":"WebhookPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/WebhookWebhookInputDto":{"id":"components/schemas/WebhookWebhookInputDto","kind":"json-schema","title":"WebhookWebhookInputDto","data":{"type":"object","properties":{"target":{"type":"string","description":"A valid target url where events should be sent to.","maxLength":742,"minLength":1,"format":"url","uniqueItems":false},"secret":{"type":"string","description":"Secret to be used to sign contents of webhooks sent by the provisioning API. You can then use the secret to verify the signature. Please not that secret should have a high entropy to be considered secure.","maxLength":128,"minLength":1,"uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BUNDLE_DONE":"Webhook event triggered when a bundle processing flow is completed.","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED":"Webhook event triggered when the RCS brand registration process status changes.","RCS_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS sender.","RCS_SENDER_OPERATOR_STATUS_UPDATED":"Webhook event triggered when an RCS sender operator status changes.","RCS_SENDER_STATUS_UPDATED":"Webhook event triggered when an RCS sender status changes.","RCS_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS account.","KAKAOTALK_SENDER_ACTIVE":"Webhook event triggered when a KakaoTalk sender becomes active.","KAKAOTALK_SENDER_INACTIVE":"Webhook event triggered when a KakaoTalk sender becomes inactive.","KAKAOTALK_SENDER_REJECTED":"Webhook event triggered when a KakaoTalk sender is rejected.","KAKAOTALK_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk sender.","KAKAOTALK_TEMPLATE_APPROVED":"Webhook event triggered when a KakaoTalk template is approved.","KAKAOTALK_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk template.","KAKAOTALK_TEMPLATE_REJECTED":"Webhook event triggered when a KakaoTalk template is rejected.","WHATSAPP_ACCOUNT_ONBOARDED":"Webhook event triggered when a WhatsApp account onboarding is completed.","WHATSAPP_ACCOUNT_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp account is pending verification.","WHATSAPP_ACCOUNT_REJECTED":"Webhook event triggered when a WhatsApp account is rejected.","WHATSAPP_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp account.","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp account daily messaging limit changes.","WHATSAPP_WABA_ACCOUNT_CHANGED":"Webhook event triggered when the linked WhatsApp Business Account changes.","WHATSAPP_SENDER_ACTIVE":"Webhook event triggered when a WhatsApp sender becomes active.","WHATSAPP_SENDER_INACTIVE":"Webhook event triggered when a WhatsApp sender becomes inactive.","WHATSAPP_SENDER_REJECTED":"Webhook event triggered when a WhatsApp sender is rejected.","WHATSAPP_SENDER_DELETED":"Webhook event triggered when a WhatsApp sender is deleted.","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED":"Webhook event triggered when a WhatsApp sender display name is updated.","WHATSAPP_SENDER_ERROR":"Webhook event triggered when a WhatsApp sender enters an error state.","WHATSAPP_SENDER_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp sender is pending verification.","WHATSAPP_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp sender.","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp sender daily messaging limit changes.","WHATSAPP_SENDER_QUALITY_RATING_CHANGED":"Webhook event triggered when a WhatsApp sender quality rating changes.","WHATSAPP_SENDER_USERNAME_UPDATED":"Webhook event triggered when a WhatsApp sender username is updated.","WHATSAPP_TEMPLATE_APPROVED":"Webhook event triggered when a WhatsApp template is approved.","WHATSAPP_TEMPLATE_REJECTED":"Webhook event triggered when a WhatsApp template is rejected.","WHATSAPP_TEMPLATE_DELETED":"Webhook event triggered when a WhatsApp template is deleted.","WHATSAPP_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp template.","WHATSAPP_TEMPLATE_STATUS_UPDATED":"Webhook event triggered when a WhatsApp template status changes.","WHATSAPP_TEMPLATE_CATEGORY_UPDATED":"Webhook event triggered when a WhatsApp template category changes.","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE":"Webhook event triggered when a future WhatsApp template category update is scheduled.","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED":"Webhook event triggered when a WhatsApp template quality score changes.","ALL":"Webhook event triggered for all supported events."},"uniqueItems":true,"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of triggers you want to be notified about on your webhook. To be able to listen to all type of events use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUNDLE_DONE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_USERNAME_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Account: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_ONBOARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_WABA_ACCOUNT_CHANGED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RCS Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_OPERATOR_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_REJECTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_REJECTED"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/WebhookWebhookTriggersEnum"}}},"required":["target","secret","triggers"]}},"components/schemas/WebhookUpdateWebhookInputDto":{"id":"components/schemas/WebhookUpdateWebhookInputDto","kind":"json-schema","title":"WebhookUpdateWebhookInputDto","data":{"type":"object","properties":{"target":{"type":"object","description":"A valid target url where events should be sent to.","maxLength":742,"minLength":1,"format":"url","uniqueItems":false},"secret":{"type":"object","description":"Secret to be used to sign contents of webhooks sent by the provisioning API. You can then use the secret to verify the signature. Please not that secret should have a high entropy to be considered secure.","maxLength":128,"minLength":1,"uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BUNDLE_DONE":"Webhook event triggered when a bundle processing flow is completed.","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED":"Webhook event triggered when the RCS brand registration process status changes.","RCS_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS sender.","RCS_SENDER_OPERATOR_STATUS_UPDATED":"Webhook event triggered when an RCS sender operator status changes.","RCS_SENDER_STATUS_UPDATED":"Webhook event triggered when an RCS sender status changes.","RCS_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS account.","KAKAOTALK_SENDER_ACTIVE":"Webhook event triggered when a KakaoTalk sender becomes active.","KAKAOTALK_SENDER_INACTIVE":"Webhook event triggered when a KakaoTalk sender becomes inactive.","KAKAOTALK_SENDER_REJECTED":"Webhook event triggered when a KakaoTalk sender is rejected.","KAKAOTALK_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk sender.","KAKAOTALK_TEMPLATE_APPROVED":"Webhook event triggered when a KakaoTalk template is approved.","KAKAOTALK_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk template.","KAKAOTALK_TEMPLATE_REJECTED":"Webhook event triggered when a KakaoTalk template is rejected.","WHATSAPP_ACCOUNT_ONBOARDED":"Webhook event triggered when a WhatsApp account onboarding is completed.","WHATSAPP_ACCOUNT_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp account is pending verification.","WHATSAPP_ACCOUNT_REJECTED":"Webhook event triggered when a WhatsApp account is rejected.","WHATSAPP_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp account.","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp account daily messaging limit changes.","WHATSAPP_WABA_ACCOUNT_CHANGED":"Webhook event triggered when the linked WhatsApp Business Account changes.","WHATSAPP_SENDER_ACTIVE":"Webhook event triggered when a WhatsApp sender becomes active.","WHATSAPP_SENDER_INACTIVE":"Webhook event triggered when a WhatsApp sender becomes inactive.","WHATSAPP_SENDER_REJECTED":"Webhook event triggered when a WhatsApp sender is rejected.","WHATSAPP_SENDER_DELETED":"Webhook event triggered when a WhatsApp sender is deleted.","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED":"Webhook event triggered when a WhatsApp sender display name is updated.","WHATSAPP_SENDER_ERROR":"Webhook event triggered when a WhatsApp sender enters an error state.","WHATSAPP_SENDER_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp sender is pending verification.","WHATSAPP_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp sender.","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp sender daily messaging limit changes.","WHATSAPP_SENDER_QUALITY_RATING_CHANGED":"Webhook event triggered when a WhatsApp sender quality rating changes.","WHATSAPP_SENDER_USERNAME_UPDATED":"Webhook event triggered when a WhatsApp sender username is updated.","WHATSAPP_TEMPLATE_APPROVED":"Webhook event triggered when a WhatsApp template is approved.","WHATSAPP_TEMPLATE_REJECTED":"Webhook event triggered when a WhatsApp template is rejected.","WHATSAPP_TEMPLATE_DELETED":"Webhook event triggered when a WhatsApp template is deleted.","WHATSAPP_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp template.","WHATSAPP_TEMPLATE_STATUS_UPDATED":"Webhook event triggered when a WhatsApp template status changes.","WHATSAPP_TEMPLATE_CATEGORY_UPDATED":"Webhook event triggered when a WhatsApp template category changes.","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE":"Webhook event triggered when a future WhatsApp template category update is scheduled.","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED":"Webhook event triggered when a WhatsApp template quality score changes.","ALL":"Webhook event triggered for all supported events."},"uniqueItems":true,"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of triggers you want to be notified about on your webhook. To be able to listen to all type of events use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUNDLE_DONE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_USERNAME_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Account: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_ONBOARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_WABA_ACCOUNT_CHANGED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RCS Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_OPERATOR_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_REJECTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_REJECTED"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/WebhookWebhookTriggersEnum"}}}}},"components/schemas/WebhookWebhookListDto":{"id":"components/schemas/WebhookWebhookListDto","kind":"json-schema","title":"WebhookWebhookListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"webhooks":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WebhookWebhookDto"}}},"required":["totalSize","pageSize","webhooks"]}},"components/schemas/WhatsappPapiErrorDto":{"id":"components/schemas/WhatsappPapiErrorDto","kind":"json-schema","title":"WhatsappPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/WhatsappSenderStatesEnum":{"id":"components/schemas/WhatsappSenderStatesEnum","kind":"json-schema","title":"WhatsappSenderStatesEnum","data":{"type":"string","enum":["ACTIVE","IN_PROGRESS","INACTIVE","PENDING_VERIFICATION","SUSPENDED","ERROR"],"description":"The current state of the sender."}},"components/schemas/WhatsappSenderWhatsAppVerticalEnum":{"id":"components/schemas/WhatsappSenderWhatsAppVerticalEnum","kind":"json-schema","title":"WhatsappSenderWhatsAppVerticalEnum","data":{"type":"string","enum":["ALCOHOL","AUTOMOTIVE","BEAUTY_SPA_SALON","CLOTHING_AND_APPAREL","EDUCATION","ENTERTAINMENT","EVENT_PLANNING_AND_SERVICE","FINANCE_AND_BANKING","FOOD_AND_GROCERY","HOTEL_AND_LODGING","MEDICAL_AND_HEALTH","NON_PROFIT","NOT_SET","ONLINE_GAMBLING","OTC_DRUGS","OTHER","PHYSICAL_GAMBLING","PROFESSIONAL_SERVICES","PUBLIC_SERVICE","RESTAURANT","SHOPPING_AND_RETAIL","TRAVEL_AND_TRANSPORTATION","UNRECOGNIZED"],"description":"Category of the sender displayed in the Business Info within WhatsApp."}},"components/schemas/WhatsappSenderDetailsDto":{"id":"components/schemas/WhatsappSenderDetailsDto","kind":"json-schema","title":"WhatsappSenderDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","description":"Sender display name within WhatsApp.","uniqueItems":false},"description":{"type":"string","description":"Description of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false},"vertical":{"x-enumDescriptions":{"ALCOHOL":"The brand operates within the alcohol sector.","AUTOMOTIVE":"The brand operates within the automotive sector.","BEAUTY_SPA_SALON":"The brand operates within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"The brand operates within clothing and apparel commerce.","EDUCATION":"The brand operates within the education field.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"The brand operates within event planning and corporate services.","FINANCE_AND_BANKING":"The brand operates within financial and banking services.","FOOD_AND_GROCERY":"The brand operates within the food supply or grocery sector.","HOTEL_AND_LODGING":"The brand operates within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"The brand operates within healthcare, medical services, or pharmaceuticals.","NON_PROFIT":"The brand is a registered non-profit organization.","NOT_SET":"The operational business vertical has not been selected.","ONLINE_GAMBLING":"The brand operates within the online gambling or betting industry.","OTC_DRUGS":"The brand operates within over-the-counter drug sales and distribution.","OTHER":"The brand operates in an industry outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"The brand operates within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"The brand provides corporate, professional, or technical services.","PUBLIC_SERVICE":"The brand provides public utilities or governmental services.","RESTAURANT":"The brand operates a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"The brand operates within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"The brand operates within transportation, travel, or logistics services.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVerticalEnum"}]},"email":{"type":"string","description":"Contact email displayed in the Business Info within WhatsApp.","uniqueItems":false},"address":{"type":"string","description":"Business address displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteOne":{"type":"string","description":"Business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteTwo":{"type":"string","description":"Second business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"about":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"About text displayed in the Business Info within WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hyperlinks can be included but will not render as clickable links."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markdown is not supported."},"children":[]}]}]}]}],"uniqueItems":false},"photoUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the sender image displayed in WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 5MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 192 x 192 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum image dimensions: 640 x 640 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image will be cropped to maximum image dimensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit a PNG image with a transparent background, the background will be rendered as black."},"children":[]}]}]}]}],"uniqueItems":false},"username":{"type":"string","description":"WhatsApp Business username of the sender.","uniqueItems":false}},"required":["displayName","vertical"]}},"components/schemas/WhatsappSenderChangesDetailsDto":{"id":"components/schemas/WhatsappSenderChangesDetailsDto","kind":"json-schema","title":"WhatsappSenderChangesDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","description":"Sender display name within WhatsApp.","uniqueItems":false},"description":{"type":"string","description":"Description of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false},"vertical":{"x-enumDescriptions":{"ALCOHOL":"The brand operates within the alcohol sector.","AUTOMOTIVE":"The brand operates within the automotive sector.","BEAUTY_SPA_SALON":"The brand operates within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"The brand operates within clothing and apparel commerce.","EDUCATION":"The brand operates within the education field.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"The brand operates within event planning and corporate services.","FINANCE_AND_BANKING":"The brand operates within financial and banking services.","FOOD_AND_GROCERY":"The brand operates within the food supply or grocery sector.","HOTEL_AND_LODGING":"The brand operates within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"The brand operates within healthcare, medical services, or pharmaceuticals.","NON_PROFIT":"The brand is a registered non-profit organization.","NOT_SET":"The operational business vertical has not been selected.","ONLINE_GAMBLING":"The brand operates within the online gambling or betting industry.","OTC_DRUGS":"The brand operates within over-the-counter drug sales and distribution.","OTHER":"The brand operates in an industry outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"The brand operates within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"The brand provides corporate, professional, or technical services.","PUBLIC_SERVICE":"The brand provides public utilities or governmental services.","RESTAURANT":"The brand operates a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"The brand operates within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"The brand operates within transportation, travel, or logistics services.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVerticalEnum"}]},"email":{"type":"string","description":"Contact email displayed in the Business Info within WhatsApp.","uniqueItems":false},"address":{"type":"string","description":"Business address displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteOne":{"type":"string","description":"Business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteTwo":{"type":"string","description":"Second business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"about":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"About text displayed in the Business Info within WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hyperlinks can be included but will not render as clickable links."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markdown is not supported."},"children":[]}]}]}]}],"uniqueItems":false},"photoUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the sender image displayed in WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 5MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 192 x 192 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum image dimensions: 640 x 640 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image will be cropped to maximum image dimensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit a PNG image with a transparent background, the background will be rendered as black."},"children":[]}]}]}]}],"uniqueItems":false},"username":{"type":"string","description":"WhatsApp Business username of the sender.","uniqueItems":false}}}},"components/schemas/WhatsappSenderStatusesEnum":{"id":"components/schemas/WhatsappSenderStatusesEnum","kind":"json-schema","title":"WhatsappSenderStatusesEnum","data":{"type":"string","enum":["DRAFT","ERROR","IN_PROGRESS","MULTIPLE_WABA_ERROR","REJECTED"],"description":"Current status of the pending changes."}},"components/schemas/WhatsappSenderErrorCodeEnum":{"id":"components/schemas/WhatsappSenderErrorCodeEnum","kind":"json-schema","title":"WhatsappSenderErrorCodeEnum","data":{"type":"string","enum":["CANNOT_ASSIGN_CREDIT_LINE","CANNOT_ASSIGN_SYSTEM_USER","CANNOT_CREATE_NEW_WHATSAPP_SENDER","CANNOT_CREATE_WABA_FOR_BUSINESS","CANNOT_GET_DETAILS_FOR_CLOUD_API","CANNOT_GET_WABA_DETAILS","CANNOT_REGISTER_NEW_WHATSAPP_SENDER","CANNOT_REGISTER_TO_CLOUD_API","CANNOT_SUBSCRIBE_TO_CLOUD_API","CANNOT_SUBSCRIBE_TO_WEBHOOK","DUPLICATES_ON_SENDER_PHONE_NUMBER","FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES","MULTIPLE_WABA_FOR_PROJECT_ID","NO_CERTIFICATE_AVAILABLE","NO_NOVA_ACCOUNT_ID","NO_PRICING_PLAN","NO_PROJECT_ID","NO_VERIFIED_PHONE_NUMBER","NOT_VERIFIED_REQUESTED_PHONE_NUMBER","NOT_VERIFY_BUSINESS_VIA_WHATSAPP","NOVA_ACCOUNT_ID_CONFLICT","PROJECT_ID_CONFLICT","REQUESTED_PHONE_NUMBER_OR_COUNTRY_CODE_CONFLICT","SENDER_HAS_BEEN_DELETED","WABA_CONNECTED_TO_ANOTHER_PROJECT","UNKNOWN_ERROR","UNRECOGNIZED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code if sender is in state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/WhatsappSenderChangesDto":{"id":"components/schemas/WhatsappSenderChangesDto","kind":"json-schema","title":"WhatsappSenderChangesDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"APPROVED":"The profile field modification has been approved and applied.","DEFERRED":"The profile field modification has been deferred and will be evaluated later.","DELETED":"The profile field modification has been removed and is no longer active.","EXPIRED":"The profile field modification expired prior to completion.","PENDING":"The profile field modification is currently awaiting review or system processing.","REJECTED":"The profile field modification has been reviewed and rejected.","RESERVED":"The requested field parameter value is reserved but has not yet received final approval.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version.","UNSPECIFIED":"The operational status of the field modification is unspecified."},"description":"Current status of the pending changes.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderStatusesEnum"}]},"details":{"anyOf":[{"$ref":"#/components/schemas/WhatsappSenderDetailsDto","description":"For newly created sender"},{"$ref":"#/components/schemas/WhatsappSenderChangesDetailsDto","description":"For update sender"}],"description":"The pending changes to sender details and information","uniqueItems":false},"errorReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error reason if sender is in state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"uniqueItems":false},"errorCode":{"x-enumDescriptions":{"CANNOT_ASSIGN_CREDIT_LINE":"Indicates the provisioning system failed to allocate an active financial credit line configuration.","CANNOT_ASSIGN_SYSTEM_USER":"Indicates the system failed to map an active system user credential reference to the resource context.","CANNOT_CREATE_NEW_WHATSAPP_SENDER":"Indicates a structural failure occurred during the initialization of the WhatsApp channel.","CANNOT_CREATE_WABA_FOR_BUSINESS":"Indicates the automated registration workflow failed to instantiate a new WhatsApp Business Account (WABA).","CANNOT_GET_DETAILS_FOR_CLOUD_API":"Indicates an upstream communication breakdown prevented fetching active Cloud API configuration parameters.","CANNOT_GET_WABA_DETAILS":"Indicates system query layers failed to retrieve account metadata from the core WhatsApp business registry.","CANNOT_REGISTER_NEW_WHATSAPP_SENDER":"Indicates the downstream carrier gateway rejected the initial registration request block.","CANNOT_REGISTER_TO_CLOUD_API":"Indicates the system could not link the communication profile context with Meta Cloud API nodes.","CANNOT_SUBSCRIBE_TO_CLOUD_API":"Indicates the background event handler failed to bind operational event listeners on the Cloud API cluster.","CANNOT_SUBSCRIBE_TO_WEBHOOK":"Indicates the streaming broker layer rejected the integration callback subscription sequence.","DUPLICATES_ON_SENDER_PHONE_NUMBER":"Indicates the provided phone number identifier is already mapped to another active routing terminal.","FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES":"Indicates an operational query failure prevented compiling the list of certified payload templates.","MULTIPLE_WABA_FOR_PROJECT_ID":"Indicates a project boundary isolation violation where multiple WABA assets exist for a single project context.","NO_CERTIFICATE_AVAILABLE":"Indicates the system lacks a valid cryptographic handshake or validation certificate to proceed.","NO_NOVA_ACCOUNT_ID":"The internal financial node identifier property is missing or null.","NO_PRICING_PLAN":"The billing rate plan or pricing schema pointer is missing from the request context.","NO_PROJECT_ID":"The project boundary isolation reference identifier is missing or null.","NO_VERIFIED_PHONE_NUMBER":"The request payload contains no verified phone number pointers capable of routing.","REQUESTED_PHONE_NUMBER_OR_COUNTRY_CODE_CONFLICT":"Requested phone number or country code are not the same as assigned in WABA.","NOT_VERIFIED_REQUESTED_PHONE_NUMBER":"The targeted phone number resource context has not completed verified lifecycle milestones.","NOT_VERIFY_BUSINESS_VIA_WHATSAPP":"The Meta ecosystem rejected compliance verification for the associated business organization.","NOVA_ACCOUNT_ID_CONFLICT":"The input financial node identifier conflicts with an existing persistent registration.","PROJECT_ID_CONFLICT":"The input project boundary reference identifier conflicts with an existing persistent registration.","SENDER_HAS_BEEN_DELETED":"The designated channel entity footprint has already undergone a permanent cascading deletion sequence.","WABA_CONNECTED_TO_ANOTHER_PROJECT":"The specified WhatsApp Business Account is actively locked to a separate project isolation layer.","UNKNOWN_ERROR":"An unclassified internal processing error occurred within the orchestration tier.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code if sender is in state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderErrorCodeEnum"}]}},"required":["status"]}},"components/schemas/WhatsappWhatsAppSenderFieldUpdateStatusEnum":{"id":"components/schemas/WhatsappWhatsAppSenderFieldUpdateStatusEnum","kind":"json-schema","title":"WhatsappWhatsAppSenderFieldUpdateStatusEnum","data":{"type":"string","enum":["APPROVED","DEFERRED","DELETED","EXPIRED","PENDING","REJECTED","RESERVED","UNRECOGNIZED","UNSPECIFIED"],"description":"Current approval status of the field."}},"components/schemas/WhatsappSenderMetadataFieldDto":{"id":"components/schemas/WhatsappSenderMetadataFieldDto","kind":"json-schema","title":"WhatsappSenderMetadataFieldDto","data":{"type":"object","properties":{"value":{"type":"string","description":"Requested value of the field.","uniqueItems":false},"status":{"x-enumDescriptions":{"APPROVED":"The profile field modification has been approved and applied.","DEFERRED":"The profile field modification has been deferred and will be evaluated later.","DELETED":"The profile field modification has been removed and is no longer active.","EXPIRED":"The profile field modification expired prior to completion.","PENDING":"The profile field modification is currently awaiting review or system processing.","REJECTED":"The profile field modification has been reviewed and rejected.","RESERVED":"The requested field parameter value is reserved but has not yet received final approval.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version.","UNSPECIFIED":"The operational status of the field modification is unspecified."},"description":"Current approval status of the field.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWhatsAppSenderFieldUpdateStatusEnum"}]},"rejectionReason":{"type":"string","description":"Reason for rejection if the field update was rejected.","uniqueItems":false}},"required":["status"]}},"components/schemas/WhatsappSenderMetadataDto":{"id":"components/schemas/WhatsappSenderMetadataDto","kind":"json-schema","title":"WhatsappSenderMetadataDto","data":{"type":"object","properties":{"displayName":{"description":"Approval status of the sender display name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetadataFieldDto"}]},"username":{"description":"Approval status of the sender username.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetadataFieldDto"}]}}}},"components/schemas/WhatsappSenderBotRegionEnum":{"id":"components/schemas/WhatsappSenderBotRegionEnum","kind":"json-schema","title":"WhatsappSenderBotRegionEnum","data":{"type":"string","enum":["BR","EU","US","UNRECOGNIZED"],"description":"Region sender is provisioned in."}},"components/schemas/WhatsappSenderMetaLocalStoragesEnum":{"id":"components/schemas/WhatsappSenderMetaLocalStoragesEnum","kind":"json-schema","title":"WhatsappSenderMetaLocalStoragesEnum","data":{"type":"string","enum":["AE","AU","BH","BR","CA","CH","DE","GB","ID","IN","JP","KR","SG","US","ZA","UNRECOGNIZED","UNSPECIFIED"],"description":"Region sender store the data in Meta."}},"components/schemas/WhatsappConversationApiAppRegionsEnum":{"id":"components/schemas/WhatsappConversationApiAppRegionsEnum","kind":"json-schema","title":"WhatsappConversationApiAppRegionsEnum","data":{"type":"string","enum":["BR","EU","US","UNRECOGNIZED"],"description":"App region."}},"components/schemas/WhatsappConversationAppChannelIntegrationStatusEnum":{"id":"components/schemas/WhatsappConversationAppChannelIntegrationStatusEnum","kind":"json-schema","title":"WhatsappConversationAppChannelIntegrationStatusEnum","data":{"type":"string","enum":["ACTIVE","FAILING","PENDING","UNRECOGNIZED"],"description":"Status of the channel credentials integration."}},"components/schemas/WhatsappConversationApiAppDto":{"id":"components/schemas/WhatsappConversationApiAppDto","kind":"json-schema","title":"WhatsappConversationApiAppDto","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the app","uniqueItems":false},"projectId":{"type":"string","description":"ID of the app project","uniqueItems":false},"region":{"x-enumDescriptions":{"BR":"The application operates within the Brazil region.","EU":"The application operates within the Europe region.","US":"The application operates within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"App region.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappConversationApiAppRegionsEnum"}]},"channelStatus":{"x-enumDescriptions":{"ACTIVE":"The channel integration is active and operating as expected.","FAILING":"The channel integration is failing and requires manual attention or troubleshooting.","PENDING":"The channel integration setup or synchronization is pending completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Status of the channel credentials integration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappConversationAppChannelIntegrationStatusEnum"}]}},"required":["id","projectId","region"]}},"components/schemas/WhatsappQualityRatingEnum":{"id":"components/schemas/WhatsappQualityRatingEnum","kind":"json-schema","title":"WhatsappQualityRatingEnum","data":{"type":"string","enum":["GREEN","RED","YELLOW","UNKNOWN","UNRECOGNIZED"],"description":"Current quality rating of the sender."}},"components/schemas/WhatsappDailyLimitEnum":{"id":"components/schemas/WhatsappDailyLimitEnum","kind":"json-schema","title":"WhatsappDailyLimitEnum","data":{"type":"string","enum":["NOT_SET","TIER_100K","TIER_10K","TIER_1K","TIER_250","TIER_2K","TIER_50","TIER_UNLIMITED","UNRECOGNIZED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property is deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountDto.businessDailyLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Current daily message limit of the sender."},"children":[]}]}]}]}},"components/schemas/WhatsappSenderNumberProviderTypeEnum":{"id":"components/schemas/WhatsappSenderNumberProviderTypeEnum","kind":"json-schema","title":"WhatsappSenderNumberProviderTypeEnum","data":{"type":"string","enum":["CUSTOMER","SINCH","UNRECOGNIZED"],"description":"Provider for phone number."}},"components/schemas/WhatsappBusinessManagersEnum":{"id":"components/schemas/WhatsappBusinessManagersEnum","kind":"json-schema","title":"WhatsappBusinessManagersEnum","data":{"type":"string","enum":["SINCH_AMERICA","SINCH_BR","SINCH_MX","SINCH_SEP","SINCH_UK","UNRECOGNIZED"],"description":"Business manager."}},"components/schemas/WhatsappWabaBanStatesEnum":{"id":"components/schemas/WhatsappWabaBanStatesEnum","kind":"json-schema","title":"WhatsappWabaBanStatesEnum","data":{"type":"string","enum":["DISABLE","REINSTATE","SCHEDULE_FOR_DISABLE","UNRECOGNIZED"],"description":"Please use get account endpoint for this information."}},"components/schemas/WhatsappConversationAppRegionsEnum":{"id":"components/schemas/WhatsappConversationAppRegionsEnum","kind":"json-schema","title":"WhatsappConversationAppRegionsEnum","data":{"type":"string","enum":["br","eu","us"],"description":"Conversation API app regions the sender can be used for."}},"components/schemas/WhatsappActionsEnum":{"id":"components/schemas/WhatsappActionsEnum","kind":"json-schema","title":"WhatsappActionsEnum","data":{"type":"string","enum":["DRAFT","SUBMIT"],"description":"Create as draft or submit. Defaults to draft."}},"components/schemas/WhatsappSenderInputWhatsAppVerticalEnum":{"id":"components/schemas/WhatsappSenderInputWhatsAppVerticalEnum","kind":"json-schema","title":"WhatsappSenderInputWhatsAppVerticalEnum","data":{"type":"string","enum":["ALCOHOL","AUTOMOTIVE","BEAUTY_SPA_SALON","CLOTHING_AND_APPAREL","EDUCATION","ENTERTAINMENT","EVENT_PLANNING_AND_SERVICE","FINANCE_AND_BANKING","FOOD_AND_GROCERY","HOTEL_AND_LODGING","MEDICAL_AND_HEALTH","NON_PROFIT","ONLINE_GAMBLING","OTC_DRUGS","OTHER","PHYSICAL_GAMBLING","PROFESSIONAL_SERVICES","PUBLIC_SERVICE","RESTAURANT","SHOPPING_AND_RETAIL","TRAVEL_AND_TRANSPORTATION"],"description":"Category of the sender displayed in the Business Info within WhatsApp."}},"components/schemas/WhatsappUpdateSenderInputDetailsDto":{"id":"components/schemas/WhatsappUpdateSenderInputDetailsDto","kind":"json-schema","title":"WhatsappUpdateSenderInputDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":128,"description":"Sender display name within WhatsApp.","uniqueItems":false},"description":{"minLength":1,"maxLength":512,"description":"Description of the sender displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"vertical":{"x-enumDescriptions":{"ALCOHOL":"Configures the sender profile for a brand operating within the alcohol sector.","AUTOMOTIVE":"Configures the sender profile for a brand operating within the automotive sector.","BEAUTY_SPA_SALON":"Configures the sender profile for a brand operating within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"Configures the sender profile for a brand operating within clothing and apparel commerce.","EDUCATION":"Configures the sender profile for a brand operating within the education field.","ENTERTAINMENT":"Configures the sender profile for a brand operating within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"Configures the sender profile for a brand operating within event planning and corporate services.","FINANCE_AND_BANKING":"Configures the sender profile for a brand operating within financial and banking services.","FOOD_AND_GROCERY":"Configures the sender profile for a brand operating within the food supply or grocery sector.","HOTEL_AND_LODGING":"Configures the sender profile for a brand operating within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"Configures the sender profile for a brand operating within healthcare or medical services.","NON_PROFIT":"Configures the sender profile for a registered non-profit organization.","ONLINE_GAMBLING":"Configures the sender profile for a brand operating within the online gambling or betting industry.","OTC_DRUGS":"Configures the sender profile for a brand operating within over-the-counter drug sales and distribution.","OTHER":"Configures the sender profile for an industry operating outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"Configures the sender profile for a brand operating within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"Configures the sender profile for a brand providing corporate, professional, or technical services.","PUBLIC_SERVICE":"Configures the sender profile for a brand providing public utilities or governmental services.","RESTAURANT":"Configures the sender profile for a brand operating a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"Configures the sender profile for a brand operating within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"Configures the sender profile for a brand operating within transportation, travel, or logistics services."},"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputWhatsAppVerticalEnum"}]},"email":{"format":"email","maxLength":128,"description":"Contact email displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"address":{"minLength":1,"maxLength":256,"description":"Business address displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"websiteOne":{"format":"url","maxLength":256,"description":"Business website displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"websiteTwo":{"format":"url","maxLength":256,"description":"Second business website displayed in the Business Info within WhatsApp. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"about":{"minLength":1,"maxLength":139,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"About text displayed in the Business Info within WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hyperlinks can be included but will not render as clickable links."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markdown is not supported."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null the value will be deleted."},"children":[]}]}]}]}],"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"photoUrl":{"format":"url","maxLength":256,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the sender image displayed in WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 5MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 192 x 192 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum image dimensions: 640 x 640 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image will be cropped to maximum image dimensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit a PNG image with a transparent background, the background will be rendered as black. If null the value will be deleted."},"children":[]}]}]}]}],"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"username":{"minLength":1,"description":"WhatsApp Business username of the sender.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}}}},"components/schemas/WhatsappUpdateSenderInputDto":{"id":"components/schemas/WhatsappUpdateSenderInputDto","kind":"json-schema","title":"WhatsappUpdateSenderInputDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActionsEnum"}]},"details":{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappUpdateSenderInputDetailsDto"}]}}}},"components/schemas/WhatsappCountryCodesEnum":{"id":"components/schemas/WhatsappCountryCodesEnum","kind":"json-schema","title":"WhatsappCountryCodesEnum","data":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","UNRECOGNIZED"],"description":"Upscalable country codes (ISO 3166-1 alpha-2)."}},"components/schemas/WhatsappComponentTypeHeaderEnum":{"id":"components/schemas/WhatsappComponentTypeHeaderEnum","kind":"json-schema","title":"WhatsappComponentTypeHeaderEnum","data":{"type":"string","const":"HEADER"}},"components/schemas/WhatsappLocationHeaderComponentFormatEnum":{"id":"components/schemas/WhatsappLocationHeaderComponentFormatEnum","kind":"json-schema","title":"WhatsappLocationHeaderComponentFormatEnum","data":{"type":"string","const":"LOCATION"}},"components/schemas/WhatsappLocationHeaderComponentDto":{"id":"components/schemas/WhatsappLocationHeaderComponentDto","kind":"json-schema","title":"WhatsappLocationHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"LOCATION":"Configures the structural template header block to host coordinate and geolocational location arrays."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentFormatEnum"}]}},"required":["type","format"]}},"components/schemas/WhatsappTextHeaderComponentFormatEnum":{"id":"components/schemas/WhatsappTextHeaderComponentFormatEnum","kind":"json-schema","title":"WhatsappTextHeaderComponentFormatEnum","data":{"type":"string","const":"TEXT"}},"components/schemas/WhatsappTextHeaderComponentDto":{"id":"components/schemas/WhatsappTextHeaderComponentDto","kind":"json-schema","title":"WhatsappTextHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"TEXT":"Configures the structural template header block to host alphanumeric text copy strings."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentFormatEnum"}]},"text":{"type":"string","description":"Text to show in the header","uniqueItems":false},"example":{"type":"string","description":"Example for the header variable.","uniqueItems":false}},"required":["type","format"]}},"components/schemas/WhatsappMediaHeaderComponentFormatEnum":{"id":"components/schemas/WhatsappMediaHeaderComponentFormatEnum","kind":"json-schema","title":"WhatsappMediaHeaderComponentFormatEnum","data":{"type":"string","enum":["DOCUMENT","IMAGE","VIDEO"]}},"components/schemas/WhatsappMediaHeaderExampleDto":{"id":"components/schemas/WhatsappMediaHeaderExampleDto","kind":"json-schema","title":"WhatsappMediaHeaderExampleDto","data":{"type":"object","properties":{"url":{"type":"string","format":"url","uniqueItems":false}}}},"components/schemas/WhatsappMediaHeaderComponentDto":{"id":"components/schemas/WhatsappMediaHeaderComponentDto","kind":"json-schema","title":"WhatsappMediaHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"IMAGE":"Configures the structural template header block to host static image media assets.","VIDEO":"Configures the structural template header block to host short video media assets.","DOCUMENT":"Configures the structural template header block to host file and document media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentFormatEnum"}]},"examples":[{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderExampleDto"}]}]},"required":["type","format"]}},"components/schemas/WhatsappComponentTypeBodyEnum":{"id":"components/schemas/WhatsappComponentTypeBodyEnum","kind":"json-schema","title":"WhatsappComponentTypeBodyEnum","data":{"type":"string","const":"BODY"}},"components/schemas/WhatsappBodyComponentDto":{"id":"components/schemas/WhatsappBodyComponentDto","kind":"json-schema","title":"WhatsappBodyComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BODY":"Defines the primary structural layout block containing the main text message and variables."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBodyEnum"}]},"text":{"type":"string","uniqueItems":false},"examples":{"description":"Examples for the body variables.","uniqueItems":false,"type":"array","items":{"type":"string"}},"addSecurityRecommendation":{"type":"boolean","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappComponentTypeFooterEnum":{"id":"components/schemas/WhatsappComponentTypeFooterEnum","kind":"json-schema","title":"WhatsappComponentTypeFooterEnum","data":{"type":"string","const":"FOOTER"}},"components/schemas/WhatsappFooterComponentDto":{"id":"components/schemas/WhatsappFooterComponentDto","kind":"json-schema","title":"WhatsappFooterComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"FOOTER":"Defines the supplementary structural layout block used for faint text copy or legal disclaimers."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeFooterEnum"}]},"text":{"type":"string","uniqueItems":false},"codeExpirationMinutes":{"type":"number","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypePhoneNumberEnum":{"id":"components/schemas/WhatsappButtonTypePhoneNumberEnum","kind":"json-schema","title":"WhatsappButtonTypePhoneNumberEnum","data":{"type":"string","const":"PHONE_NUMBER"}},"components/schemas/WhatsappPhoneNumberButtonDto":{"id":"components/schemas/WhatsappPhoneNumberButtonDto","kind":"json-schema","title":"WhatsappPhoneNumberButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"PHONE_NUMBER":"Defines an interactive component that routes natively to the host hardware dialer array."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypePhoneNumberEnum"}]},"text":{"type":"string","uniqueItems":false},"phoneNumber":{"type":"string","format":"phone number","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeUrlEnum":{"id":"components/schemas/WhatsappButtonTypeUrlEnum","kind":"json-schema","title":"WhatsappButtonTypeUrlEnum","data":{"type":"string","const":"URL"}},"components/schemas/WhatsappUrlButtonDto":{"id":"components/schemas/WhatsappUrlButtonDto","kind":"json-schema","title":"WhatsappUrlButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"URL":"Defines an interactive component that switches viewports out of the client app into a dedicated browser environment."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeUrlEnum"}]},"text":{"type":"string","uniqueItems":false},"url":{"type":"string","format":"url","uniqueItems":false},"examples":[{"type":"string","format":"url","uniqueItems":false}]},"required":["type"]}},"components/schemas/WhatsappButtonTypeQuickReplyEnum":{"id":"components/schemas/WhatsappButtonTypeQuickReplyEnum","kind":"json-schema","title":"WhatsappButtonTypeQuickReplyEnum","data":{"type":"string","const":"QUICK_REPLY"}},"components/schemas/WhatsappQuickReplyButtonDto":{"id":"components/schemas/WhatsappQuickReplyButtonDto","kind":"json-schema","title":"WhatsappQuickReplyButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"QUICK_REPLY":"Defines an interactive component that routes immediate, automated textual response payloads back to the host gateway."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeQuickReplyEnum"}]},"text":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeOtpEnum":{"id":"components/schemas/WhatsappButtonTypeOtpEnum","kind":"json-schema","title":"WhatsappButtonTypeOtpEnum","data":{"type":"string","const":"OTP"}},"components/schemas/WhatsappOtpTypeEnum":{"id":"components/schemas/WhatsappOtpTypeEnum","kind":"json-schema","title":"WhatsappOtpTypeEnum","data":{"type":"string","enum":["COPY_CODE","ONE_TAP","ZERO_TAP","UNRECOGNIZED"]}},"components/schemas/WhatsappSupportedAppDto":{"id":"components/schemas/WhatsappSupportedAppDto","kind":"json-schema","title":"WhatsappSupportedAppDto","data":{"type":"object","properties":{"packageName":{"type":"string","uniqueItems":false},"signatureHash":{"type":"string","uniqueItems":false}},"required":["packageName","signatureHash"]}},"components/schemas/WhatsappOtpButtonDto":{"id":"components/schemas/WhatsappOtpButtonDto","kind":"json-schema","title":"WhatsappOtpButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"OTP":"Defines an interactive component configured to transmit immediate high-volume verification tokens."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOtpEnum"}]},"otpType":{"x-enumDescriptions":{"COPY_CODE":"Configures the verification layout to present a plain-text code that the user can manually copy or transfer.","ONE_TAP":"Configures the verification layout to invoke a native device callback wrapper, requiring a single tap confirmation from the user.","ZERO_TAP":"Configures the verification layout to execute automated background authentication handshake layers without requiring manual user input.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappOtpTypeEnum"}]},"text":{"type":"string","uniqueItems":false},"autofillText":{"type":"string","uniqueItems":false},"packageName":{"type":"string","deprecated":true,"uniqueItems":false},"signatureHash":{"type":"string","deprecated":true,"uniqueItems":false},"supportedApps":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappSupportedAppDto"}},"zeroTapTermsAccepted":{"type":"boolean","uniqueItems":false}},"required":["type","otpType"]}},"components/schemas/WhatsappButtonTypeEnum":{"id":"components/schemas/WhatsappButtonTypeEnum","kind":"json-schema","title":"WhatsappButtonTypeEnum","data":{"type":"string","const":"FLOW"}},"components/schemas/WhatsappFlowActionEnum":{"id":"components/schemas/WhatsappFlowActionEnum","kind":"json-schema","title":"WhatsappFlowActionEnum","data":{"type":"string","enum":["DATA_EXCHANGE","NAVIGATE","UNKNOWN","UNRECOGNIZED"],"description":"Flow action"}},"components/schemas/WhatsappFlowButtonDto":{"id":"components/schemas/WhatsappFlowButtonDto","kind":"json-schema","title":"WhatsappFlowButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"FLOW":"Defines an interactive component that initializes an embedded native rich interaction flow."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeEnum"}]},"text":{"type":"string","description":"Text to display on the Flow button","uniqueItems":false},"flowId":{"type":"string","description":"Flow ID to launch when button is pressed","uniqueItems":false},"flowAction":{"x-enumDescriptions":{"DATA_EXCHANGE":"Triggers an asynchronous data synchronization payload transfer with the configured webhook or API endpoint.","NAVIGATE":"Advances the interactive user workflow viewport context to the subsequent structural layout step.","UNKNOWN":"The targeted interaction action code type cannot be resolved.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Flow action","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappFlowActionEnum"}]},"navigateScreen":{"type":"string","description":"The unique ID of the first screen. Required for Navigate action.","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeRequestContactInfoEnum":{"id":"components/schemas/WhatsappButtonTypeRequestContactInfoEnum","kind":"json-schema","title":"WhatsappButtonTypeRequestContactInfoEnum","data":{"type":"string","const":"REQUEST_CONTACT_INFO"}},"components/schemas/WhatsappRequestContactInfoButtonDto":{"id":"components/schemas/WhatsappRequestContactInfoButtonDto","kind":"json-schema","title":"WhatsappRequestContactInfoButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"REQUEST_CONTACT_INFO":"Defines an interactive component that prompts native interface sharing configurations to harvest user identity footprints."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeRequestContactInfoEnum"}]},"text":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeOrderDetailsEnum":{"id":"components/schemas/WhatsappButtonTypeOrderDetailsEnum","kind":"json-schema","title":"WhatsappButtonTypeOrderDetailsEnum","data":{"type":"string","const":"ORDER_DETAILS"}},"components/schemas/WhatsappOrderDetailsButtonDto":{"id":"components/schemas/WhatsappOrderDetailsButtonDto","kind":"json-schema","title":"WhatsappOrderDetailsButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"ORDER_DETAILS":"Defines an interactive component that directs the customer to systemic order tracking metadata views."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOrderDetailsEnum"}]},"text":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappButtonTypeCopyCodeEnum":{"id":"components/schemas/WhatsappButtonTypeCopyCodeEnum","kind":"json-schema","title":"WhatsappButtonTypeCopyCodeEnum","data":{"type":"string","const":"COPY_CODE"}},"components/schemas/WhatsappCopyCodeButtonDto":{"id":"components/schemas/WhatsappCopyCodeButtonDto","kind":"json-schema","title":"WhatsappCopyCodeButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"COPY_CODE":"Defines an interactive component that copies a code snippet."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeCopyCodeEnum"}]},"text":{"type":"string","uniqueItems":false},"examples":[{"type":"string","uniqueItems":false}]},"required":["type"]}},"components/schemas/WhatsappComponentTypeButtonsEnum":{"id":"components/schemas/WhatsappComponentTypeButtonsEnum","kind":"json-schema","title":"WhatsappComponentTypeButtonsEnum","data":{"type":"string","const":"BUTTONS"}},"components/schemas/WhatsappButtonsComponentDto":{"id":"components/schemas/WhatsappButtonsComponentDto","kind":"json-schema","title":"WhatsappButtonsComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BUTTONS":"Defines the interactive layout block hosting quick reply or call-to-action components."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtonsEnum"}]},"buttons":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappPhoneNumberButtonDto"},{"$ref":"#/components/schemas/WhatsappUrlButtonDto"},{"$ref":"#/components/schemas/WhatsappQuickReplyButtonDto"},{"$ref":"#/components/schemas/WhatsappOtpButtonDto"},{"$ref":"#/components/schemas/WhatsappFlowButtonDto"},{"$ref":"#/components/schemas/WhatsappRequestContactInfoButtonDto"},{"$ref":"#/components/schemas/WhatsappOrderDetailsButtonDto"},{"$ref":"#/components/schemas/WhatsappCopyCodeButtonDto"}]},"uniqueItems":false}},"required":["type","buttons"]}},"components/schemas/WhatsappComponentTypeCarouselEnum":{"id":"components/schemas/WhatsappComponentTypeCarouselEnum","kind":"json-schema","title":"WhatsappComponentTypeCarouselEnum","data":{"type":"string","const":"CAROUSEL"}},"components/schemas/WhatsappCardHeaderComponentFormatsEnum":{"id":"components/schemas/WhatsappCardHeaderComponentFormatsEnum","kind":"json-schema","title":"WhatsappCardHeaderComponentFormatsEnum","data":{"type":"string","enum":["IMAGE","VIDEO"],"description":"Card header format."}},"components/schemas/WhatsappCardHeaderComponentDto":{"id":"components/schemas/WhatsappCardHeaderComponentDto","kind":"json-schema","title":"WhatsappCardHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"IMAGE":"Configures the structural template header block to host static image media assets.","VIDEO":"Configures the structural template header block to host short video media assets."},"description":"Card header format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentFormatsEnum"}]},"examples":[{"description":"Uploaded media asset handle.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderExampleDto"}]}]},"required":["type","format"]}},"components/schemas/WhatsappCardBodyComponentDto":{"id":"components/schemas/WhatsappCardBodyComponentDto","kind":"json-schema","title":"WhatsappCardBodyComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BODY":"Defines the primary structural layout block containing the main text message and variables."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBodyEnum"}]},"examples":{"description":"Examples for the body variables.","uniqueItems":false,"type":"array","items":{"type":"string"}},"text":{"type":"string","description":"Card body text.","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappCardButtonsComponentDto":{"id":"components/schemas/WhatsappCardButtonsComponentDto","kind":"json-schema","title":"WhatsappCardButtonsComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BUTTONS":"Defines the interactive layout block hosting quick reply or call-to-action components."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtonsEnum"}]},"buttons":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappUrlButtonDto"},{"$ref":"#/components/schemas/WhatsappQuickReplyButtonDto"},{"$ref":"#/components/schemas/WhatsappPhoneNumberButtonDto"}]},"description":"Card buttons.","uniqueItems":false}},"required":["type","buttons"]}},"components/schemas/WhatsappCardDto":{"id":"components/schemas/WhatsappCardDto","kind":"json-schema","title":"WhatsappCardDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappCardBodyComponentDto"},{"$ref":"#/components/schemas/WhatsappCardButtonsComponentDto"}]},"description":"List of components in the cards.","uniqueItems":false}},"required":["components"]}},"components/schemas/WhatsappCarouselComponentDto":{"id":"components/schemas/WhatsappCarouselComponentDto","kind":"json-schema","title":"WhatsappCarouselComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"CAROUSEL":"Defines a dynamic multimedia block configured with horizontal scrolling multi-card cards."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeCarouselEnum"}]},"cards":{"description":"Media cards.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappCardDto"}}},"required":["type","cards"]}},"components/schemas/WhatsappBidStrategiesEnum":{"id":"components/schemas/WhatsappBidStrategiesEnum","kind":"json-schema","title":"WhatsappBidStrategiesEnum","data":{"type":"string","enum":["BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","BID_STRATEGY_UNSPECIFIED","UNRECOGNIZED"],"description":"Bid strategy returned for the template optimization configuration."}},"components/schemas/WhatsappTemplateDetailsOptimizationDto":{"id":"components/schemas/WhatsappTemplateDetailsOptimizationDto","kind":"json-schema","title":"WhatsappTemplateDetailsOptimizationDto","data":{"type":"object","properties":{"bidAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum price returned for 1,000 message deliveries, expressed in your WABA currency's smallest unit (for example, cents for USD). Example: a value of 5000 represents $0.05 USD per delivery (5 cents x 1,000 messages)."},"children":[]}]}]}],"uniqueItems":false},"bidStrategy":{"x-enumDescriptions":{"BID_STRATEGY_UNSPECIFIED":"No bid strategy was specified for the template optimization configuration.","BID_STRATEGY_LOWEST_COST_WITH_BID_CAP":"The template optimization configuration uses the lowest-cost strategy with a bid cap.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Bid strategy returned for the template optimization configuration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappBidStrategiesEnum"}]},"bidCountryMultiplierOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country-specific bid multipliers returned by the upstream system, keyed by ISO 3166-1 alpha-2 country code. Values are strings to preserve decimal precision. If not provided, the default bid multiplier of 1.0 is applied for all countries. Allowed range is 0.0 to 10.0. Example: { \"US\": \"1.2\", \"GB\": \"1.1\" }."},"children":[]}]}]}],"uniqueItems":false}},"required":["bidAmount","bidStrategy"]}},"components/schemas/WhatsappComponentTypeLimitedTimeOfferEnum":{"id":"components/schemas/WhatsappComponentTypeLimitedTimeOfferEnum","kind":"json-schema","title":"WhatsappComponentTypeLimitedTimeOfferEnum","data":{"type":"string","const":"LIMITED_TIME_OFFER"}},"components/schemas/WhatsappLimitedTimeOfferComponentDto":{"id":"components/schemas/WhatsappLimitedTimeOfferComponentDto","kind":"json-schema","title":"WhatsappLimitedTimeOfferComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"LIMITED_TIME_OFFER":"Defines a dynamic structural layout block for showcasing time-sensitive promotional offers and urgency-driven purchase incentives."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeLimitedTimeOfferEnum"}]},"text":{"type":"string","description":"Offer details text.","uniqueItems":false},"hasExpiration":{"type":"boolean","description":"Indicates if the offer expiration details appear in the delivered message.","uniqueItems":false}},"required":["type","hasExpiration"]}},"components/schemas/WhatsappTemplateDetailsDto":{"id":"components/schemas/WhatsappTemplateDetailsDto","kind":"json-schema","title":"WhatsappTemplateDetailsDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappBodyComponentDto"},{"$ref":"#/components/schemas/WhatsappFooterComponentDto"},{"$ref":"#/components/schemas/WhatsappButtonsComponentDto"},{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappCarouselComponentDto"},{"$ref":"#/components/schemas/WhatsappLimitedTimeOfferComponentDto"}]},"description":"List of components in the template. Must contain a BODY component and can only have one entry of each type.","uniqueItems":false},"messageSendTtlSeconds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKETING"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizable range"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 seconds to 15 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 hours to 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 seconds to 12 hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 to 900 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43200 to 2592000 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 to 43200 seconds"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days."},"children":[]}]}]}],"uniqueItems":false},"optimization":{"description":"Optimization settings for the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDetailsOptimizationDto"}]}},"required":["components"]}},"components/schemas/WhatsappTemplateChangesDetailsDto":{"id":"components/schemas/WhatsappTemplateChangesDetailsDto","kind":"json-schema","title":"WhatsappTemplateChangesDetailsDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappBodyComponentDto"},{"$ref":"#/components/schemas/WhatsappFooterComponentDto"},{"$ref":"#/components/schemas/WhatsappButtonsComponentDto"},{"$ref":"#/components/schemas/WhatsappCarouselComponentDto"},{"$ref":"#/components/schemas/WhatsappLimitedTimeOfferComponentDto"}]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has not been submitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has been submitted."},"children":[]}]}]}],"uniqueItems":false},"messageSendTtlSeconds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKETING"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizable range"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 seconds to 15 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 hours to 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 seconds to 12 hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 to 900 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43200 to 2592000 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 to 43200 seconds"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days."},"children":[]}]}]}],"uniqueItems":false},"optimization":{"description":"Optimization settings for the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDetailsOptimizationDto"}]}}}},"components/schemas/WhatsappTemplateStatusesEnum":{"id":"components/schemas/WhatsappTemplateStatusesEnum","kind":"json-schema","title":"WhatsappTemplateStatusesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","REJECTED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has not been submitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has been submitted."},"children":[]}]}]}]}},"components/schemas/WhatsappTemplateChangesDto":{"id":"components/schemas/WhatsappTemplateChangesDto","kind":"json-schema","title":"WhatsappTemplateChangesDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"The template changes are saved as a draft only.","IN_PROGRESS":"The template changes have been submitted and are still processing.","REJECTED":"The template changes have been reviewed and rejected."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has not been submitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has been submitted."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateStatusesEnum"}]},"allowCategoryChange":{"type":"boolean","description":"True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false.","uniqueItems":false},"details":{"anyOf":[{"$ref":"#/components/schemas/WhatsappTemplateDetailsDto","description":"For newly created template"},{"$ref":"#/components/schemas/WhatsappTemplateChangesDetailsDto","description":"For update template"}],"description":"Template details and information.","uniqueItems":false}},"required":["status"]}},"components/schemas/WhatsappTemplateAnalyticsButtonTypesEnum":{"id":"components/schemas/WhatsappTemplateAnalyticsButtonTypesEnum","kind":"json-schema","title":"WhatsappTemplateAnalyticsButtonTypesEnum","data":{"type":"string","enum":["QUICK_REPLY","UNIQUE_URL","URL","UNRECOGNIZED"],"description":"Type of button."}},"components/schemas/WhatsappTemplateAnalyticsButtonsDto":{"id":"components/schemas/WhatsappTemplateAnalyticsButtonsDto","kind":"json-schema","title":"WhatsappTemplateAnalyticsButtonsDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"QUICK_REPLY":"Aggregates interaction metrics for static pre-configured response buttons.","UNIQUE_URL":"Aggregates interaction metrics for call-to-action buttons configured with dynamic tracking URLs.","URL":"Aggregates interaction metrics for call-to-action buttons redirecting to static web hyperlinks.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Type of button.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsButtonTypesEnum"}]},"content":{"type":"string","description":"Content of the button.","uniqueItems":false},"clicks":{"type":"number","description":"Number of times the button has been clicked.","uniqueItems":false}},"required":["type","content","clicks"]}},"components/schemas/WhatsappTemplateAnalyticsDto":{"id":"components/schemas/WhatsappTemplateAnalyticsDto","kind":"json-schema","title":"WhatsappTemplateAnalyticsDto","data":{"type":"object","properties":{"sent":{"type":"number","description":"Number of times template has been sent.","uniqueItems":false},"delivered":{"type":"number","description":"Number of times template has been delivered.","uniqueItems":false},"read":{"type":"number","description":"Number of times template has been read.","uniqueItems":false},"start":{"type":"string","description":"The UTC Date Time in ISO 8601 for start of date range.","uniqueItems":false},"end":{"type":"string","description":"The UTC Date Time in ISO 8601 for end of date range.","uniqueItems":false},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsButtonsDto"},"description":"Number of times buttons in the template has been clicked.","uniqueItems":false}},"required":["sent","delivered","read","start","end","buttons"]}},"components/schemas/WhatsappTemplateStatesEnum":{"id":"components/schemas/WhatsappTemplateStatesEnum","kind":"json-schema","title":"WhatsappTemplateStatesEnum","data":{"type":"string","enum":["APPROVED","DISABLED","PAUSED","PENDING","REJECTED"]}},"components/schemas/WhatsappTemplateLanguagesEnum":{"id":"components/schemas/WhatsappTemplateLanguagesEnum","kind":"json-schema","title":"WhatsappTemplateLanguagesEnum","data":{"type":"string","enum":["AF","AR","AZ","BG","BN","CA","CS","DA","DE","EL","EN","EN_GB","EN_US","ES","ES_AR","ES_ES","ES_MX","ES_UY","ET","FA","FI","FIL","FR","GA","GU","HA","HE","HI","HR","HU","ID","IT","JA","KA","KK","KN","KO","KY_KG","LO","LT","LV","MK","ML","MR","MS","NB","NL","PA","PL","PT_BR","PT_PT","RO","RU","RW_RW","SK","SL","SQ","SR","SV","SW","TA","TE","TH","TR","UK","UR","UZ","VI","ZH_CN","ZH_HK","ZH_TW","ZU","UNRECOGNIZED"]}},"components/schemas/WhatsappTemplateCategoryEnum":{"id":"components/schemas/WhatsappTemplateCategoryEnum","kind":"json-schema","title":"WhatsappTemplateCategoryEnum","data":{"type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY","UNRECOGNIZED"]}},"components/schemas/WhatsappTemplateRejectionCodeEnum":{"id":"components/schemas/WhatsappTemplateRejectionCodeEnum","kind":"json-schema","title":"WhatsappTemplateRejectionCodeEnum","data":{"type":"string","enum":["ABUSIVE_CONTENT","INCORRECT_CATEGORY","INVALID_FORMAT","NONE","SCAM","UNRECOGNIZED"],"description":"Rejection code if template is in status 'REJECTED'"}},"components/schemas/WhatsappTemplateQualityScoreEnum":{"id":"components/schemas/WhatsappTemplateQualityScoreEnum","kind":"json-schema","title":"WhatsappTemplateQualityScoreEnum","data":{"type":"string","enum":["QUALITY_SCORE_GREEN","QUALITY_SCORE_RED","QUALITY_SCORE_YELLOW","QUALITY_SCORE_UNKNOWN","UNRECOGNIZED"],"description":"Quality score of the HSM."}},"components/schemas/WhatsappTemplateDto":{"id":"components/schemas/WhatsappTemplateDto","kind":"json-schema","title":"WhatsappTemplateDto","data":{"type":"object","properties":{"whatsappId":{"type":"string","uniqueItems":false},"state":{"x-enumDescriptions":{"APPROVED":"The template is approved and available for use.","DISABLED":"The template has been disabled and is restricted from outbound messaging operations.","PAUSED":"The template is temporarily paused and cannot be utilized until explicitly resumed.","PENDING":"The template is queued and currently awaiting approval or processing milestones.","REJECTED":"The template was rejected and cannot be used."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateStatesEnum"}]},"name":{"type":"string","uniqueItems":false},"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ES_UY":"The language configuration is set to Uruguayan Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguagesEnum"}]},"category":{"x-enumDescriptions":{"AUTHENTICATION":"Billing or functional category for authentication and verification messages.","MARKETING":"Billing or functional category for promotional or marketing messages.","UTILITY":"Billing or functional category for utility and service-related messages.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateCategoryEnum"}]},"rejectionCode":{"x-enumDescriptions":{"ABUSIVE_CONTENT":"The upstream gateway rejected the layout because the messaging copy violated safety, spam, or abuse criteria.","INCORRECT_CATEGORY":"The upstream gateway rejected the layout because the business vertical classification does not align with the actual content.","INVALID_FORMAT":"The upstream gateway rejected the layout because variable placeholders, syntax parameters, or media configurations are invalid.","NONE":"The template has not faced any restriction codes or rejection events.","SCAM":"The upstream gateway rejected the layout because the text patterns match fraudulent, deceptive, or financial scam signatures.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Rejection code if template is in status 'REJECTED'","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateRejectionCodeEnum"}]},"qualityScore":{"x-enumDescriptions":{"QUALITY_SCORE_GREEN":"Indicates an optimal template delivery standing reflecting low user block counts.","QUALITY_SCORE_RED":"Indicates a severely degraded template standing, which may trigger suspension or delivery throttling.","QUALITY_SCORE_YELLOW":"Indicates a warning template standing reflecting a notable increase in recent opt-out actions.","QUALITY_SCORE_UNKNOWN":"The platform has not collected sufficient telemetry data to compute an active quality rating.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Quality score of the HSM.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateQualityScoreEnum"}]},"changes":{"description":"Object containing changes on the template. If empty the changes has been approved and applied to the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateChangesDto"}]},"details":{"description":"Template details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDetailsDto"}]},"analytics":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsDto"},"description":"Template analytics.","uniqueItems":false},"isMetaGenerated":{"type":"boolean","description":"Indicates if the template was auto-generated by Meta.","uniqueItems":false}},"required":["name","language","category","analytics","isMetaGenerated"]}},"components/schemas/WhatsappPartialTextHeaderComponentDto":{"id":"components/schemas/WhatsappPartialTextHeaderComponentDto","kind":"json-schema","title":"WhatsappPartialTextHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"TEXT":"Configures the structural template header block to host alphanumeric text copy strings."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentFormatEnum"}]},"text":{"type":"string","description":"Text to show in the header","uniqueItems":false},"example":{"type":"string","description":"Example for the header variable.","uniqueItems":false}}}},"components/schemas/WhatsappPartialMediaHeaderExampleDto":{"id":"components/schemas/WhatsappPartialMediaHeaderExampleDto","kind":"json-schema","title":"WhatsappPartialMediaHeaderExampleDto","data":{"type":"object","properties":{"url":{"type":"string","format":"url","uniqueItems":false}}}},"components/schemas/WhatsappPartialMediaHeaderComponentDto":{"id":"components/schemas/WhatsappPartialMediaHeaderComponentDto","kind":"json-schema","title":"WhatsappPartialMediaHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"IMAGE":"Configures the structural template header block to host static image media assets.","VIDEO":"Configures the structural template header block to host short video media assets.","DOCUMENT":"Configures the structural template header block to host file and document media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentFormatEnum"}]},"examples":[{"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappPartialMediaHeaderExampleDto"}]}]}}},"components/schemas/WhatsappPartialBodyComponentDto":{"id":"components/schemas/WhatsappPartialBodyComponentDto","kind":"json-schema","title":"WhatsappPartialBodyComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BODY":"Defines the primary structural layout block containing the main text message and variables."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBodyEnum"}]},"text":{"type":"string","uniqueItems":false},"examples":{"description":"Examples for the body variables.","uniqueItems":false,"type":"array","items":{"type":"string"}},"addSecurityRecommendation":{"type":"boolean","uniqueItems":false}}}},"components/schemas/WhatsappPartialFooterComponentDto":{"id":"components/schemas/WhatsappPartialFooterComponentDto","kind":"json-schema","title":"WhatsappPartialFooterComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"FOOTER":"Defines the supplementary structural layout block used for faint text copy or legal disclaimers."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeFooterEnum"}]},"text":{"type":"string","uniqueItems":false},"codeExpirationMinutes":{"type":"number","uniqueItems":false}}}},"components/schemas/WhatsappPartialLocationHeaderComponentDto":{"id":"components/schemas/WhatsappPartialLocationHeaderComponentDto","kind":"json-schema","title":"WhatsappPartialLocationHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"LOCATION":"Configures the structural template header block to host coordinate and geolocational location arrays."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentFormatEnum"}]}}}},"components/schemas/WhatsappPartialCardHeaderComponentDto":{"id":"components/schemas/WhatsappPartialCardHeaderComponentDto","kind":"json-schema","title":"WhatsappPartialCardHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"IMAGE":"Configures the structural template header block to host static image media assets.","VIDEO":"Configures the structural template header block to host short video media assets."},"description":"Card header format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentFormatsEnum"}]},"examples":[{"description":"Uploaded media asset handle.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappPartialMediaHeaderExampleDto"}]}]}}},"components/schemas/WhatsappPartialCardBodyComponentDto":{"id":"components/schemas/WhatsappPartialCardBodyComponentDto","kind":"json-schema","title":"WhatsappPartialCardBodyComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BODY":"Defines the primary structural layout block containing the main text message and variables."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBodyEnum"}]},"examples":{"description":"Examples for the body variables.","uniqueItems":false,"type":"array","items":{"type":"string"}},"text":{"type":"string","description":"Card body text.","uniqueItems":false}}}},"components/schemas/WhatsappPartialUrlButtonDto":{"id":"components/schemas/WhatsappPartialUrlButtonDto","kind":"json-schema","title":"WhatsappPartialUrlButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"URL":"Defines an interactive component that switches viewports out of the client app into a dedicated browser environment."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeUrlEnum"}]},"text":{"type":"string","uniqueItems":false},"url":{"type":"string","format":"url","uniqueItems":false},"examples":[{"type":"string","format":"url","uniqueItems":false}]}}},"components/schemas/WhatsappPartialQuickReplyButtonDto":{"id":"components/schemas/WhatsappPartialQuickReplyButtonDto","kind":"json-schema","title":"WhatsappPartialQuickReplyButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"QUICK_REPLY":"Defines an interactive component that routes immediate, automated textual response payloads back to the host gateway."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeQuickReplyEnum"}]},"text":{"type":"string","uniqueItems":false}}}},"components/schemas/WhatsappPartialPhoneNumberButtonDto":{"id":"components/schemas/WhatsappPartialPhoneNumberButtonDto","kind":"json-schema","title":"WhatsappPartialPhoneNumberButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"PHONE_NUMBER":"Defines an interactive component that routes natively to the host hardware dialer array."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypePhoneNumberEnum"}]},"text":{"type":"string","uniqueItems":false},"phoneNumber":{"type":"string","format":"phone number","uniqueItems":false}}}},"components/schemas/WhatsappPartialCardButtonsComponentDto":{"id":"components/schemas/WhatsappPartialCardButtonsComponentDto","kind":"json-schema","title":"WhatsappPartialCardButtonsComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BUTTONS":"Defines the interactive layout block hosting quick reply or call-to-action components."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtonsEnum"}]},"buttons":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappPartialUrlButtonDto"},{"$ref":"#/components/schemas/WhatsappPartialQuickReplyButtonDto"},{"$ref":"#/components/schemas/WhatsappPartialPhoneNumberButtonDto"}]},"description":"Card buttons.","uniqueItems":false}}}},"components/schemas/WhatsappPartialCardDto":{"id":"components/schemas/WhatsappPartialCardDto","kind":"json-schema","title":"WhatsappPartialCardDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappPartialCardHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialCardBodyComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialCardButtonsComponentDto"}]},"description":"List of components in the cards.","uniqueItems":false}}}},"components/schemas/WhatsappPartialCarouselComponentDto":{"id":"components/schemas/WhatsappPartialCarouselComponentDto","kind":"json-schema","title":"WhatsappPartialCarouselComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"CAROUSEL":"Defines a dynamic multimedia block configured with horizontal scrolling multi-card cards."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeCarouselEnum"}]},"cards":{"description":"Media cards.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappPartialCardDto"}}}}},"components/schemas/WhatsappPartialLimitedTimeOfferComponentDto":{"id":"components/schemas/WhatsappPartialLimitedTimeOfferComponentDto","kind":"json-schema","title":"WhatsappPartialLimitedTimeOfferComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"LIMITED_TIME_OFFER":"Defines a dynamic structural layout block for showcasing time-sensitive promotional offers and urgency-driven purchase incentives."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeLimitedTimeOfferEnum"}]},"text":{"type":"string","description":"Offer details text.","uniqueItems":false},"hasExpiration":{"type":"boolean","description":"Indicates if the offer expiration details appear in the delivered message.","uniqueItems":false}}}},"components/schemas/WhatsappPartialTemplateDetailsDto":{"id":"components/schemas/WhatsappPartialTemplateDetailsDto","kind":"json-schema","title":"WhatsappPartialTemplateDetailsDto","data":{"type":"object","properties":{"messageSendTtlSeconds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKETING"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizable range"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 seconds to 15 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 hours to 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 seconds to 12 hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 to 900 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43200 to 2592000 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 to 43200 seconds"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days."},"children":[]}]}]}],"uniqueItems":false},"optimization":{"description":"Optimization settings for the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDetailsOptimizationDto"}]},"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappPartialTextHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialMediaHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialBodyComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialFooterComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialButtonsComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialLocationHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialCarouselComponentDto"},{"$ref":"#/components/schemas/WhatsappPartialLimitedTimeOfferComponentDto"}]},"description":"List of components in the template. Must contain a BODY component and can only have one entry of each type.","uniqueItems":false}}}},"components/schemas/WhatsappPartialOtpButtonDto":{"id":"components/schemas/WhatsappPartialOtpButtonDto","kind":"json-schema","title":"WhatsappPartialOtpButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"OTP":"Defines an interactive component configured to transmit immediate high-volume verification tokens."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOtpEnum"}]},"otpType":{"x-enumDescriptions":{"COPY_CODE":"Configures the verification layout to present a plain-text code that the user can manually copy or transfer.","ONE_TAP":"Configures the verification layout to invoke a native device callback wrapper, requiring a single tap confirmation from the user.","ZERO_TAP":"Configures the verification layout to execute automated background authentication handshake layers without requiring manual user input.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappOtpTypeEnum"}]},"text":{"type":"string","uniqueItems":false},"autofillText":{"type":"string","uniqueItems":false},"packageName":{"type":"string","deprecated":true,"uniqueItems":false},"signatureHash":{"type":"string","deprecated":true,"uniqueItems":false},"supportedApps":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappSupportedAppDto"}},"zeroTapTermsAccepted":{"type":"boolean","uniqueItems":false}}}},"components/schemas/WhatsappPartialFlowButtonDto":{"id":"components/schemas/WhatsappPartialFlowButtonDto","kind":"json-schema","title":"WhatsappPartialFlowButtonDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"FLOW":"Defines an interactive component that initializes an embedded native rich interaction flow."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeEnum"}]},"text":{"type":"string","description":"Text to display on the Flow button","uniqueItems":false},"flowId":{"type":"string","description":"Flow ID to launch when button is pressed","uniqueItems":false},"flowAction":{"x-enumDescriptions":{"DATA_EXCHANGE":"Triggers an asynchronous data synchronization payload transfer with the configured webhook or API endpoint.","NAVIGATE":"Advances the interactive user workflow viewport context to the subsequent structural layout step.","UNKNOWN":"The targeted interaction action code type cannot be resolved.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Flow action","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappFlowActionEnum"}]},"navigateScreen":{"type":"string","description":"The unique ID of the first screen. Required for Navigate action.","uniqueItems":false}}}},"components/schemas/WhatsappPartialButtonsComponentDto":{"id":"components/schemas/WhatsappPartialButtonsComponentDto","kind":"json-schema","title":"WhatsappPartialButtonsComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BUTTONS":"Defines the interactive layout block hosting quick reply or call-to-action components."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtonsEnum"}]},"buttons":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappPartialPhoneNumberButtonDto"},{"$ref":"#/components/schemas/WhatsappPartialUrlButtonDto"},{"$ref":"#/components/schemas/WhatsappPartialQuickReplyButtonDto"},{"$ref":"#/components/schemas/WhatsappPartialOtpButtonDto"},{"$ref":"#/components/schemas/WhatsappPartialFlowButtonDto"}]},"uniqueItems":false}}}},"components/schemas/WhatsappPartialTemplateChangesDto":{"id":"components/schemas/WhatsappPartialTemplateChangesDto","kind":"json-schema","title":"WhatsappPartialTemplateChangesDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"The template changes are saved as a draft only.","IN_PROGRESS":"The template changes have been submitted and are still processing.","REJECTED":"The template changes have been reviewed and rejected."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has not been submitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The changes has been submitted."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateStatusesEnum"}]},"allowCategoryChange":{"type":"boolean","description":"True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false.","uniqueItems":false},"details":{"oneOf":[{"$ref":"#/components/schemas/WhatsappPartialTemplateDetailsDto","description":"For newly created template"},{"$ref":"#/components/schemas/WhatsappTemplateChangesDetailsDto","description":"For update template"}],"description":"Template details and information.","uniqueItems":false}}}},"components/schemas/WhatsappPartialTemplateAnalyticsButtonsDto":{"id":"components/schemas/WhatsappPartialTemplateAnalyticsButtonsDto","kind":"json-schema","title":"WhatsappPartialTemplateAnalyticsButtonsDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"QUICK_REPLY":"Aggregates interaction metrics for static pre-configured response buttons.","UNIQUE_URL":"Aggregates interaction metrics for call-to-action buttons configured with dynamic tracking URLs.","URL":"Aggregates interaction metrics for call-to-action buttons redirecting to static web hyperlinks.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Type of button.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsButtonTypesEnum"}]},"content":{"type":"string","description":"Content of the button.","uniqueItems":false},"clicks":{"type":"number","description":"Number of times the button has been clicked.","uniqueItems":false}}}},"components/schemas/WhatsappPartialTemplateAnalyticsDto":{"id":"components/schemas/WhatsappPartialTemplateAnalyticsDto","kind":"json-schema","title":"WhatsappPartialTemplateAnalyticsDto","data":{"type":"object","properties":{"sent":{"type":"number","description":"Number of times template has been sent.","uniqueItems":false},"delivered":{"type":"number","description":"Number of times template has been delivered.","uniqueItems":false},"read":{"type":"number","description":"Number of times template has been read.","uniqueItems":false},"start":{"type":"string","description":"The UTC Date Time in ISO 8601 for start of date range.","uniqueItems":false},"end":{"type":"string","description":"The UTC Date Time in ISO 8601 for end of date range.","uniqueItems":false},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappPartialTemplateAnalyticsButtonsDto"},"description":"Number of times buttons in the template has been clicked.","uniqueItems":false}}}},"components/schemas/WhatsappPartialTemplateDto":{"id":"components/schemas/WhatsappPartialTemplateDto","kind":"json-schema","title":"WhatsappPartialTemplateDto","data":{"type":"object","properties":{"whatsappId":{"type":"string","uniqueItems":false},"state":{"x-enumDescriptions":{"APPROVED":"The template is approved and available for use.","DISABLED":"The template has been disabled and is restricted from outbound messaging operations.","PAUSED":"The template is temporarily paused and cannot be utilized until explicitly resumed.","PENDING":"The template is queued and currently awaiting approval or processing milestones.","REJECTED":"The template was rejected and cannot be used."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateStatesEnum"}]},"name":{"type":"string","uniqueItems":false},"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ES_UY":"The language configuration is set to Uruguayan Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguagesEnum"}]},"category":{"x-enumDescriptions":{"AUTHENTICATION":"Billing or functional category for authentication and verification messages.","MARKETING":"Billing or functional category for promotional or marketing messages.","UTILITY":"Billing or functional category for utility and service-related messages.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateCategoryEnum"}]},"rejectionCode":{"x-enumDescriptions":{"ABUSIVE_CONTENT":"The upstream gateway rejected the layout because the messaging copy violated safety, spam, or abuse criteria.","INCORRECT_CATEGORY":"The upstream gateway rejected the layout because the business vertical classification does not align with the actual content.","INVALID_FORMAT":"The upstream gateway rejected the layout because variable placeholders, syntax parameters, or media configurations are invalid.","NONE":"The template has not faced any restriction codes or rejection events.","SCAM":"The upstream gateway rejected the layout because the text patterns match fraudulent, deceptive, or financial scam signatures.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Rejection code if template is in status 'REJECTED'","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateRejectionCodeEnum"}]},"qualityScore":{"x-enumDescriptions":{"QUALITY_SCORE_GREEN":"Indicates an optimal template delivery standing reflecting low user block counts.","QUALITY_SCORE_RED":"Indicates a severely degraded template standing, which may trigger suspension or delivery throttling.","QUALITY_SCORE_YELLOW":"Indicates a warning template standing reflecting a notable increase in recent opt-out actions.","QUALITY_SCORE_UNKNOWN":"The platform has not collected sufficient telemetry data to compute an active quality rating.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Quality score of the HSM.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateQualityScoreEnum"}]},"isMetaGenerated":{"type":"boolean","description":"Indicates if the template was auto-generated by Meta.","uniqueItems":false},"changes":{"description":"Object containing changes on the template. If empty the changes has been approved and applied to the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappPartialTemplateChangesDto"}]},"details":{"description":"Template details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappPartialTemplateDetailsDto"}]},"analytics":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappPartialTemplateAnalyticsDto"},"description":"Template analytics.","uniqueItems":false}}}},"components/schemas/WhatsappTemplateDtoFieldMaskPathsEnum":{"id":"components/schemas/WhatsappTemplateDtoFieldMaskPathsEnum","kind":"json-schema","title":"WhatsappTemplateDtoFieldMaskPathsEnum","data":{"type":"string","enum":["whatsappId","state","name","language","category","rejectionCode","qualityScore","changes","changes.status","changes.allowCategoryChange","changes.details","changes.details.components","changes.details.components.0.type","changes.details.components.0.format","changes.details.components.0.text","changes.details.components.0.example","changes.details.components.0.example.url","changes.details.components.0.examples","changes.details.components.0.addSecurityRecommendation","changes.details.components.0.codeExpirationMinutes","changes.details.components.0.buttons","changes.details.components.0.buttons.0.type","changes.details.components.0.buttons.0.text","changes.details.components.0.buttons.0.phoneNumber","changes.details.components.0.buttons.0.url","changes.details.components.0.buttons.0.example","changes.details.components.0.buttons.0.otpType","changes.details.components.0.buttons.0.autofillText","changes.details.components.0.buttons.0.packageName","changes.details.components.0.buttons.0.signatureHash","changes.details.components.0.buttons.0.supportedApps","changes.details.components.0.buttons.0.supportedApps.0.packageName","changes.details.components.0.buttons.0.supportedApps.0.signatureHash","changes.details.components.0.buttons.0.zeroTapTermsAccepted","changes.details.components.0.buttons.0.flowId","changes.details.components.0.buttons.0.flowAction","changes.details.components.0.buttons.0.navigateScreen","changes.details.components.0.hasExpiration","changes.details.messageSendTtlSeconds","changes.details.optimization","details","details.components","details.components.0.type","details.components.0.format","details.components.0.text","details.components.0.example","details.components.0.example.url","details.components.0.examples","details.components.0.addSecurityRecommendation","details.components.0.codeExpirationMinutes","details.components.0.buttons","details.components.0.buttons.0.type","details.components.0.buttons.0.text","details.components.0.buttons.0.phoneNumber","details.components.0.buttons.0.url","details.components.0.buttons.0.example","details.components.0.buttons.0.otpType","details.components.0.buttons.0.autofillText","details.components.0.buttons.0.packageName","details.components.0.buttons.0.signatureHash","details.components.0.buttons.0.supportedApps","details.components.0.buttons.0.supportedApps.0.packageName","details.components.0.buttons.0.supportedApps.0.signatureHash","details.components.0.buttons.0.zeroTapTermsAccepted","details.components.0.buttons.0.flowId","details.components.0.buttons.0.flowAction","details.components.0.buttons.0.navigateScreen","details.components.0.hasExpiration","details.messageSendTtlSeconds","details.optimization","analytics","analytics.0.sent","analytics.0.delivered","analytics.0.read","analytics.0.start","analytics.0.end","analytics.0.buttons","analytics.0.buttons.0.type","analytics.0.buttons.0.content","analytics.0.buttons.0.clicks","isMetaGenerated"]}},"components/schemas/WhatsappTemplateAnalyticsDateRangesEnum":{"id":"components/schemas/WhatsappTemplateAnalyticsDateRangesEnum","kind":"json-schema","title":"WhatsappTemplateAnalyticsDateRangesEnum","data":{"type":"string","enum":["DAY","MONTH","QUARTER","WEEK"]}},"components/schemas/WhatsappTemplateListDto":{"id":"components/schemas/WhatsappTemplateListDto","kind":"json-schema","title":"WhatsappTemplateListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"templates":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateDto"}}},"required":["totalSize","pageSize","templates"]}},"components/schemas/WhatsappPartialTemplateListDto":{"id":"components/schemas/WhatsappPartialTemplateListDto","kind":"json-schema","title":"WhatsappPartialTemplateListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"templates":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappPartialTemplateDto"}}},"required":["totalSize","pageSize","templates"]}},"components/schemas/WhatsappLocationHeaderComponentInputDto":{"id":"components/schemas/WhatsappLocationHeaderComponentInputDto","kind":"json-schema","title":"WhatsappLocationHeaderComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"LOCATION":"Configures the structural template header block to host coordinate and geolocational location arrays."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentFormatEnum"}]}},"required":["type","format"]}},"components/schemas/WhatsappTextHeaderComponentInputDto":{"id":"components/schemas/WhatsappTextHeaderComponentInputDto","kind":"json-schema","title":"WhatsappTextHeaderComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"TEXT":"Configures the structural template header block to host alphanumeric text copy strings."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTextHeaderComponentFormatEnum"}]},"text":{"type":"string","maxLength":60,"minLength":1,"description":"Text to show in the header. Can contain one header variable. Not required for draft.","uniqueItems":false},"examples":[{"type":"string","minLength":1,"description":"Example for the header variable. Required if there is a variable in the text header.","uniqueItems":false}]},"required":["type","format","text"]}},"components/schemas/WhatsappInputMediaHeaderExampleSupportedMimeTypesEnum":{"id":"components/schemas/WhatsappInputMediaHeaderExampleSupportedMimeTypesEnum","kind":"json-schema","title":"WhatsappInputMediaHeaderExampleSupportedMimeTypesEnum","data":{"type":"string","enum":["IMAGE/JPEG","IMAGE/PNG","APPLICATION/PDF","VIDEO/3GP","VIDEO/MP4"],"description":"Optional mime type of file if it can not be determined by the file contents."}},"components/schemas/WhatsappMediaHeaderExampleInputDto":{"id":"components/schemas/WhatsappMediaHeaderExampleInputDto","kind":"json-schema","title":"WhatsappMediaHeaderExampleInputDto","data":{"type":"object","properties":{"url":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images must be 8-bit, RGB or RGBA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max file size: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5MB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only H.264 video codec and AAC audio codec is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We support videos with a single audio stream or no audio stream."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video/3gp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video/mp4"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max file size: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16MB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":3,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max file size: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100MB"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not required for draft."},"children":[]}]}]}]}],"uniqueItems":false},"mimeType":{"x-enumDescriptions":{"IMAGE/JPEG":"Specifies image/jpeg as a valid media format for template header variables.","IMAGE/PNG":"Specifies image/png as a valid media format for template header variables.","APPLICATION/PDF":"Specifies application/pdf as a valid media format for template header variables.","VIDEO/3GP":"Specifies video/3gpp as a valid media format for template header variables.","VIDEO/MP4":"Specifies video/mp4 as a valid media format for template header variables."},"description":"Optional mime type of file if it can not be determined by the file contents.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputMediaHeaderExampleSupportedMimeTypesEnum"}]}},"required":["url"]}},"components/schemas/WhatsappMediaHeaderComponentInputDto":{"id":"components/schemas/WhatsappMediaHeaderComponentInputDto","kind":"json-schema","title":"WhatsappMediaHeaderComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"IMAGE":"Configures the structural template header block to host static image media assets.","VIDEO":"Configures the structural template header block to host short video media assets.","DOCUMENT":"Configures the structural template header block to host file and document media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentFormatEnum"}]},"examples":[{"description":"Not required for draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappMediaHeaderExampleInputDto"}]}]},"required":["type","format","example"]}},"components/schemas/WhatsappBodyComponentInputDto":{"id":"components/schemas/WhatsappBodyComponentInputDto","kind":"json-schema","title":"WhatsappBodyComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BODY":"Defines the primary structural layout block containing the main text message and variables."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBodyEnum"}]},"text":{"type":"string","minLength":1,"maxLength":1024,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The main content of the body component. Supports variables in the format {{1}}, {{2}}, etc. Empty for AUTHENTICATION category templates."},"children":[]}]}]}],"uniqueItems":false},"examples":{"description":"Examples for the body variables. Requires one example for each variable in the body text. If no variables are used, the examples are optional.","uniqueItems":false,"type":"array","items":{"type":"string","minLength":1}},"addSecurityRecommendation":{"type":"boolean","default":false,"description":"Only valid if template category is AUTHENTICATION. If true, adds a security recommendation to the body. Defaults to false.","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappFooterComponentInputDto":{"id":"components/schemas/WhatsappFooterComponentInputDto","kind":"json-schema","title":"WhatsappFooterComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"FOOTER":"Defines the supplementary structural layout block used for faint text copy or legal disclaimers."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeFooterEnum"}]},"text":{"type":"string","maxLength":60,"uniqueItems":false},"codeExpirationMinutes":{"type":"number","description":"Only valid if template category is AUTHENTICATION. If set will add a text detailing the expiration time.","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappPhoneNumberButtonInputDto":{"id":"components/schemas/WhatsappPhoneNumberButtonInputDto","kind":"json-schema","title":"WhatsappPhoneNumberButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"PHONE_NUMBER":"Defines an interactive component that routes natively to the host hardware dialer array."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypePhoneNumberEnum"}]},"text":{"type":"string","minLength":1,"maxLength":25,"description":"Not required for draft.","uniqueItems":false},"phoneNumber":{"type":"string","format":"phone number","description":"Not required for draft.","uniqueItems":false}},"required":["type","text","phoneNumber"]}},"components/schemas/WhatsappUrlButtonInputDto":{"id":"components/schemas/WhatsappUrlButtonInputDto","kind":"json-schema","title":"WhatsappUrlButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"URL":"Defines an interactive component that switches viewports out of the client app into a dedicated browser environment."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeUrlEnum"}]},"text":{"type":"string","minLength":1,"maxLength":25,"description":"Not required for draft.","uniqueItems":false},"url":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The url address. To make it dynamic you can add '{{1}}' to the end of the url eg,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.my-website.com?name={{1}}, and not"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.my-{{1}}.com."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricted domains: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wa.me"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatsapp.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not required for draft."},"children":[]}]}]}],"uniqueItems":false},"examples":[{"type":"string","format":"url","description":"\n  Example of the full url together with the dynamic value. Required if there is a {{1}} in the URL field, eg\n  \n  If the 'url' field is 'https://www.my-website.com?name={{1}}', then example can have the following value\n\n  'example' = 'https://www.my-website.com?name=john'\n  \nNot required for draft.","uniqueItems":false}]},"required":["type","text","url"]}},"components/schemas/WhatsappQuickReplyButtonInputDto":{"id":"components/schemas/WhatsappQuickReplyButtonInputDto","kind":"json-schema","title":"WhatsappQuickReplyButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"QUICK_REPLY":"Defines an interactive component that routes immediate, automated textual response payloads back to the host gateway."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeQuickReplyEnum"}]},"text":{"type":"string","minLength":1,"maxLength":25,"description":"Not required for draft.","uniqueItems":false}},"required":["type","text"]}},"components/schemas/WhatsappInputOtpTypeEnum":{"id":"components/schemas/WhatsappInputOtpTypeEnum","kind":"json-schema","title":"WhatsappInputOtpTypeEnum","data":{"type":"string","enum":["COPY_CODE","ONE_TAP","ZERO_TAP"]}},"components/schemas/WhatsappSupportedAppInputDto":{"id":"components/schemas/WhatsappSupportedAppInputDto","kind":"json-schema","title":"WhatsappSupportedAppInputDto","data":{"type":"object","properties":{"packageName":{"type":"string","description":"Your Android app's package name.","uniqueItems":false},"signatureHash":{"type":"string","description":"Your app signing key hash.","uniqueItems":false}},"required":["packageName","signatureHash"]}},"components/schemas/WhatsappOtpButtonInputDto":{"id":"components/schemas/WhatsappOtpButtonInputDto","kind":"json-schema","title":"WhatsappOtpButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"OTP":"Defines an interactive component configured to transmit immediate high-volume verification tokens."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOtpEnum"}]},"otpType":{"x-enumDescriptions":{"COPY_CODE":"Configures the verification layout to present a plain-text code that the user can manually copy or transfer.","ONE_TAP":"Configures the verification layout to invoke a native device callback wrapper, requiring a single tap confirmation from the user.","ZERO_TAP":"Configures the verification layout to execute automated background authentication handshake layers without requiring manual user input."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputOtpTypeEnum"}]},"text":{"type":"string","minLength":1,"maxLength":25,"description":"Not required for draft.","uniqueItems":false},"autofillText":{"type":"string","maxLength":25,"description":"One-tap autofill button label text.","uniqueItems":false},"packageName":{"type":"string","deprecated":true,"description":"Your Android app's package name.","uniqueItems":false},"signatureHash":{"type":"string","deprecated":true,"description":"Your app signing key hash.","uniqueItems":false},"supportedApps":{"description":"List of supported apps for the OTP button.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappSupportedAppInputDto"}},"zeroTapTermsAccepted":{"type":"boolean","description":"Set to true to indicate that you understand that your use of zero-tap authentication is subject to the WhatsApp Business Terms of Service, and that it's your responsibility to ensure your customers expect that the code will be automatically filled in on their behalf when they choose to receive the zero-tap code through WhatsApp.","uniqueItems":false}},"required":["type","otpType","text"]}},"components/schemas/WhatsappButtonTypeFlowEnum":{"id":"components/schemas/WhatsappButtonTypeFlowEnum","kind":"json-schema","title":"WhatsappButtonTypeFlowEnum","data":{"type":"string","const":"FLOW"}},"components/schemas/WhatsappInputFlowActionEnum":{"id":"components/schemas/WhatsappInputFlowActionEnum","kind":"json-schema","title":"WhatsappInputFlowActionEnum","data":{"type":"string","enum":["DATA_EXCHANGE","NAVIGATE"],"description":"Flow action. Not required for draft."}},"components/schemas/WhatsappFlowButtonInputDto":{"id":"components/schemas/WhatsappFlowButtonInputDto","kind":"json-schema","title":"WhatsappFlowButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"FLOW":"Defines an interactive component that initializes an embedded native rich interaction flow."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeFlowEnum"}]},"text":{"type":"string","minLength":1,"maxLength":25,"description":"Text to display on the Flow button. Not required for draft.","uniqueItems":false},"flowId":{"type":"string","minLength":1,"maxLength":30,"description":"Flow ID to launch when button is pressed. Not required for draft.","format":"digits","uniqueItems":false},"flowAction":{"x-enumDescriptions":{"DATA_EXCHANGE":"Triggers an asynchronous data synchronization payload transfer with the configured webhook or API endpoint.","NAVIGATE":"Advances the interactive user workflow viewport context to the subsequent structural layout step."},"description":"Flow action. Not required for draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputFlowActionEnum"}]},"navigateScreen":{"type":"string","minLength":1,"maxLength":432,"description":"The unique ID of the first screen. Required for Navigate action.","uniqueItems":false}},"required":["type","text","flowId","flowAction"]}},"components/schemas/WhatsappRequestContactInfoButtonInputDto":{"id":"components/schemas/WhatsappRequestContactInfoButtonInputDto","kind":"json-schema","title":"WhatsappRequestContactInfoButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"REQUEST_CONTACT_INFO":"Defines an interactive component that prompts native interface sharing configurations to harvest user identity footprints."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeRequestContactInfoEnum"}]}},"required":["type"]}},"components/schemas/WhatsappOrderDetailsButtonInputDto":{"id":"components/schemas/WhatsappOrderDetailsButtonInputDto","kind":"json-schema","title":"WhatsappOrderDetailsButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"ORDER_DETAILS":"Defines an interactive component that directs the customer to systemic order tracking metadata views."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeOrderDetailsEnum"}]}},"required":["type"]}},"components/schemas/WhatsappCopyCodeButtonInputDto":{"id":"components/schemas/WhatsappCopyCodeButtonInputDto","kind":"json-schema","title":"WhatsappCopyCodeButtonInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"COPY_CODE":"Defines an interactive component that copies a code snippet."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappButtonTypeCopyCodeEnum"}]},"examples":[{"type":"string","maxLength":20,"minLength":1,"description":"Sample code.","uniqueItems":false}]},"required":["type","example"]}},"components/schemas/WhatsappButtonsComponentInputDto":{"id":"components/schemas/WhatsappButtonsComponentInputDto","kind":"json-schema","title":"WhatsappButtonsComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BUTTONS":"Defines the interactive layout block hosting quick reply or call-to-action components."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtonsEnum"}]},"buttons":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappFlowButtonInputDto"},{"$ref":"#/components/schemas/WhatsappOtpButtonInputDto"},{"$ref":"#/components/schemas/WhatsappPhoneNumberButtonInputDto"},{"$ref":"#/components/schemas/WhatsappQuickReplyButtonInputDto"},{"$ref":"#/components/schemas/WhatsappRequestContactInfoButtonInputDto"},{"$ref":"#/components/schemas/WhatsappOrderDetailsButtonInputDto"},{"$ref":"#/components/schemas/WhatsappUrlButtonInputDto"},{"$ref":"#/components/schemas/WhatsappCopyCodeButtonInputDto"}]},"minItems":1,"description":"Not required for draft. Each field in (value, text) must have unique values across items.","uniqueItems":true}},"required":["type","buttons"]}},"components/schemas/WhatsappLimitedTimeOfferComponentInputDto":{"id":"components/schemas/WhatsappLimitedTimeOfferComponentInputDto","kind":"json-schema","title":"WhatsappLimitedTimeOfferComponentInputDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"LIMITED_TIME_OFFER":"Defines a dynamic structural layout block for showcasing time-sensitive promotional offers and urgency-driven purchase incentives."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeLimitedTimeOfferEnum"}]},"text":{"type":"string","description":"Offer details text.","minLength":1,"maxLength":16,"uniqueItems":false},"hasExpiration":{"type":"boolean","description":"Set to true to have the offer expiration details appear in the delivered message.","default":false,"uniqueItems":false}},"required":["type","text"]}},"components/schemas/WhatsappInputCardMediaHeaderExampleSupportedMimeTypesEnum":{"id":"components/schemas/WhatsappInputCardMediaHeaderExampleSupportedMimeTypesEnum","kind":"json-schema","title":"WhatsappInputCardMediaHeaderExampleSupportedMimeTypesEnum","data":{"type":"string","enum":["IMAGE/JPEG","IMAGE/PNG","VIDEO/3GP","VIDEO/MP4"],"description":"Optional mime type of file if it can not be determined by the file contents."}},"components/schemas/WhatsappInputCardMediaHeaderExampleDto":{"id":"components/schemas/WhatsappInputCardMediaHeaderExampleDto","kind":"json-schema","title":"WhatsappInputCardMediaHeaderExampleDto","data":{"type":"object","properties":{"url":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images must be 8-bit, RGB or RGBA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max file size: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5MB"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only H.264 video codec and AAC audio codec is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We support videos with a single audio stream or no audio stream."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video/3gp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video/mp4"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"max file size: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16MB"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not required for draft."},"children":[]}]}]}]}],"uniqueItems":false},"mimeType":{"x-enumDescriptions":{"IMAGE/JPEG":"Specifies image/jpeg as a valid media format for rich card header variables.","IMAGE/PNG":"Specifies image/png as a valid media format for rich card header variables.","VIDEO/3GP":"Specifies video/3gpp as a valid media format for rich card header variables.","VIDEO/MP4":"Specifies video/mp4 as a valid media format for rich card header variables."},"description":"Optional mime type of file if it can not be determined by the file contents.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputCardMediaHeaderExampleSupportedMimeTypesEnum"}]}},"required":["url"]}},"components/schemas/WhatsappInputCardHeaderComponentDto":{"id":"components/schemas/WhatsappInputCardHeaderComponentDto","kind":"json-schema","title":"WhatsappInputCardHeaderComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"HEADER":"Defines the high-visibility structural layout block used for introductory text or rich media assets."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeHeaderEnum"}]},"format":{"x-enumDescriptions":{"IMAGE":"Configures the structural template header block to host static image media assets.","VIDEO":"Configures the structural template header block to host short video media assets."},"description":"Card header format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCardHeaderComponentFormatsEnum"}]},"examples":[{"description":"\nUploaded media asset handle.\nMedia assets are automatically cropped to a wide ratio based on the WhatsApp user's device.\nNot required for draft.\n","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputCardMediaHeaderExampleDto"}]}]},"required":["type","format","example"]}},"components/schemas/WhatsappInputCardBodyComponentDto":{"id":"components/schemas/WhatsappInputCardBodyComponentDto","kind":"json-schema","title":"WhatsappInputCardBodyComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BODY":"Defines the primary structural layout block containing the main text message and variables."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeBodyEnum"}]},"examples":{"description":"Examples for the body variables. Requires one example for each variable in the body text. If no variables are used, the examples are optional.","uniqueItems":false,"type":"array","items":{"type":"string","minLength":1}},"text":{"type":"string","minLength":1,"maxLength":160,"description":"Card body text. Supports variables. Not required for draft.","uniqueItems":false}},"required":["type","text"]}},"components/schemas/WhatsappInputCardButtonsComponentDto":{"id":"components/schemas/WhatsappInputCardButtonsComponentDto","kind":"json-schema","title":"WhatsappInputCardButtonsComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"BUTTONS":"Defines the interactive layout block hosting quick reply or call-to-action components."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeButtonsEnum"}]},"buttons":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappUrlButtonInputDto"},{"$ref":"#/components/schemas/WhatsappQuickReplyButtonInputDto"},{"$ref":"#/components/schemas/WhatsappPhoneNumberButtonInputDto"}]},"minItems":1,"maxItems":2,"description":"\nCard buttons.\nButton combinations can be a mix of quick reply buttons, phone number buttons, and URL buttons.\nNot required for draft.\n\nFields (type, text) must not all share the same value across items.","uniqueItems":true}},"required":["type","buttons"]}},"components/schemas/WhatsappInputCardDto":{"id":"components/schemas/WhatsappInputCardDto","kind":"json-schema","title":"WhatsappInputCardDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappInputCardHeaderComponentDto"},{"$ref":"#/components/schemas/WhatsappInputCardBodyComponentDto"},{"$ref":"#/components/schemas/WhatsappInputCardButtonsComponentDto"}]},"description":"\nList of components in the cards.\nEach card in the template has an image or video header asset, card body text, and up to two buttons.\nAll cards defined on a template must have the same components.\nNot required for draft.\n\nField 'type' must have unique values across items.","uniqueItems":true}},"required":["components"]}},"components/schemas/WhatsappInputCarouselComponentDto":{"id":"components/schemas/WhatsappInputCarouselComponentDto","kind":"json-schema","title":"WhatsappInputCarouselComponentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"CAROUSEL":"Defines a dynamic multimedia block configured with horizontal scrolling multi-card cards."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappComponentTypeCarouselEnum"}]},"cards":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappInputCardDto"},"minItems":1,"maxItems":10,"description":"\nMedia cards.\nAll cards defined on a template must have the same components.\nIt is only necessary to define two product cards upon template creation. \nAn approved template with two product cards can be used to send up to 10 cards in a template message.\nNot required for draft.\n","uniqueItems":false}},"required":["type","cards"]}},"components/schemas/WhatsappInputBidStrategiesEnum":{"id":"components/schemas/WhatsappInputBidStrategiesEnum","kind":"json-schema","title":"WhatsappInputBidStrategiesEnum","data":{"type":"string","const":"LOWEST_COST_WITH_BID_CAP","description":"Bid strategy to use for the template optimization configuration."}},"components/schemas/WhatsappInputTemplateDetailsOptimization":{"id":"components/schemas/WhatsappInputTemplateDetailsOptimization","kind":"json-schema","title":"WhatsappInputTemplateDetailsOptimization","data":{"type":"object","properties":{"bidAmount":{"type":"number","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum price to bid for 1,000 message deliveries, expressed in your WABA currency's smallest unit (for example, cents for USD). Example: a value of 5000 represents $0.05 USD per delivery (5 cents x 1,000 messages)."},"children":[]}]}]}],"uniqueItems":false},"bidStrategy":{"x-enumDescriptions":{"LOWEST_COST_WITH_BID_CAP":"Use the lowest-cost strategy with a bid cap."},"description":"Bid strategy to use for the template optimization configuration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBidStrategiesEnum"}]},"bidCountryMultiplierOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional country-specific bid multipliers, keyed by ISO 3166-1 alpha-2 country code. Values must be strings to preserve decimal precision. If not provided, the default bid multiplier of 1.0 is applied for all countries. Allowed range is 0.0 to 10.0. Example: { \"US\": \"1.2\", \"GB\": \"1.1\" }."},"children":[]}]}]}],"uniqueItems":false}},"required":["bidAmount","bidStrategy"]}},"components/schemas/WhatsappTemplateDetailsInputDto":{"id":"components/schemas/WhatsappTemplateDetailsInputDto","kind":"json-schema","title":"WhatsappTemplateDetailsInputDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentInputDto"},{"$ref":"#/components/schemas/WhatsappTextHeaderComponentInputDto"},{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentInputDto"},{"$ref":"#/components/schemas/WhatsappBodyComponentInputDto"},{"$ref":"#/components/schemas/WhatsappFooterComponentInputDto"},{"$ref":"#/components/schemas/WhatsappButtonsComponentInputDto"},{"$ref":"#/components/schemas/WhatsappInputCarouselComponentDto"},{"$ref":"#/components/schemas/WhatsappLimitedTimeOfferComponentInputDto"}]},"description":"List of components in the template. Must contain a BODY component and can only have one entry of each type. Not required for draft. Field 'type' must have unique values across items.","uniqueItems":true},"messageSendTtlSeconds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKETING"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizable range"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 seconds to 15 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 hours to 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 seconds to 12 hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 to 900 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43200 to 2592000 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 to 43200 seconds"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days."},"children":[]}]}]}],"uniqueItems":false},"optimization":{"description":"Optimization settings for the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputTemplateDetailsOptimization"}]}},"required":["components"]}},"components/schemas/WhatsappInputTemplateLanguagesEnum":{"id":"components/schemas/WhatsappInputTemplateLanguagesEnum","kind":"json-schema","title":"WhatsappInputTemplateLanguagesEnum","data":{"type":"string","enum":["AF","AR","AZ","BG","BN","CA","CS","DA","DE","EL","EN","EN_GB","EN_US","ES","ES_AR","ES_ES","ES_MX","ES_UY","ET","FA","FI","FIL","FR","GA","GU","HA","HE","HI","HR","HU","ID","IT","JA","KA","KK","KN","KO","KY_KG","LO","LT","LV","MK","ML","MR","MS","NB","NL","PA","PL","PT_BR","PT_PT","RO","RU","RW_RW","SK","SL","SQ","SR","SV","SW","TA","TE","TH","TR","UK","UR","UZ","VI","ZH_CN","ZH_HK","ZH_TW","ZU"]}},"components/schemas/WhatsappTemplateInputCategoryEnum":{"id":"components/schemas/WhatsappTemplateInputCategoryEnum","kind":"json-schema","title":"WhatsappTemplateInputCategoryEnum","data":{"type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY"]}},"components/schemas/WhatsappTemplateInputDto":{"id":"components/schemas/WhatsappTemplateInputDto","kind":"json-schema","title":"WhatsappTemplateInputDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"description":"Create as draft or submit. Defaults to submit.","default":"SUBMIT","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActionsEnum"}]},"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]*[a-z0-9]$","maxLength":512,"uniqueItems":false},"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ES_UY":"The language configuration is set to Uruguayan Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputTemplateLanguagesEnum"}]},"category":{"x-enumDescriptions":{"AUTHENTICATION":"Billing or functional category for authentication and verification messages.","MARKETING":"Billing or functional category for promotional or marketing messages.","UTILITY":"Billing or functional category for utility and service-related messages."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateInputCategoryEnum"}]},"saveDraftOnFailure":{"type":"boolean","default":false,"description":"Flag to save template as draft if submission fails. Defaults to false.","uniqueItems":false},"allowCategoryChange":{"type":"boolean","default":false,"description":"True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false.","uniqueItems":false},"details":{"description":"'Template input details and information.' Not required for draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDetailsInputDto"}]}},"required":["name","language","category","details"]}},"components/schemas/WhatsappInputUpdateTemplateDetailsOptimization":{"id":"components/schemas/WhatsappInputUpdateTemplateDetailsOptimization","kind":"json-schema","title":"WhatsappInputUpdateTemplateDetailsOptimization","data":{"type":"object","properties":{"bidAmount":{"type":"number","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum price to bid for 1,000 message deliveries, expressed in your WABA currency's smallest unit (for example, cents for USD). Example: a value of 5000 represents $0.05 USD per delivery (5 cents x 1,000 messages)."},"children":[]}]}]}],"uniqueItems":false},"bidStrategy":{"x-enumDescriptions":{"LOWEST_COST_WITH_BID_CAP":"Use the lowest-cost strategy with a bid cap."},"description":"Bid strategy to use for the template optimization configuration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBidStrategiesEnum"}]},"bidCountryMultiplierOverrides":{"additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional country-specific bid multipliers, keyed by ISO 3166-1 alpha-2 country code. Values must be strings to preserve decimal precision. If not provided, the default bid multiplier of 1.0 is applied for all countries. Allowed range is 0.0 to 10.0. Example: { \"US\": \"1.2\", \"GB\": \"1.1\" }."},"children":[]}]}]}],"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["bidAmount","bidStrategy"]}},"components/schemas/WhatsappUpdateTemplateDetailsInputDto":{"id":"components/schemas/WhatsappUpdateTemplateDetailsInputDto","kind":"json-schema","title":"WhatsappUpdateTemplateDetailsInputDto","data":{"type":"object","properties":{"components":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/WhatsappLocationHeaderComponentInputDto"},{"$ref":"#/components/schemas/WhatsappTextHeaderComponentInputDto"},{"$ref":"#/components/schemas/WhatsappMediaHeaderComponentInputDto"},{"$ref":"#/components/schemas/WhatsappBodyComponentInputDto"},{"$ref":"#/components/schemas/WhatsappFooterComponentInputDto"},{"$ref":"#/components/schemas/WhatsappButtonsComponentInputDto"},{"$ref":"#/components/schemas/WhatsappInputCarouselComponentDto"},{"$ref":"#/components/schemas/WhatsappLimitedTimeOfferComponentInputDto"}]},"description":"List of components in the template. Must contain a BODY component and can only have one entry of each type. Not required for draft. Field 'type' must have unique values across items.","uniqueItems":true},"messageSendTtlSeconds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template message delivery retry time-to-live (TTL) override value. If unable to deliver the template message, it will be periodically retry for this period of time. If it is unable to deliver the message for this period of time, the message will be dropped."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MARKETING"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTILITY"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customizable range"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 seconds to 15 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12 hours to 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 seconds to 12 hours"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 to 900 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"43200 to 2592000 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 to 43200 seconds"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that authentication templates created before October 23, 2024, have a default TTL of 30 days."},"children":[]}]}]}],"uniqueItems":false},"optimization":{"description":"Optimization settings for the template.","uniqueItems":false,"oneOf":[{"$ref":"#/components/schemas/WhatsappInputUpdateTemplateDetailsOptimization"},{"type":"null"}]}}}},"components/schemas/WhatsappUpdateTemplateInputDto":{"id":"components/schemas/WhatsappUpdateTemplateInputDto","kind":"json-schema","title":"WhatsappUpdateTemplateInputDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActionsEnum"}]},"category":{"x-enumDescriptions":{"AUTHENTICATION":"Billing or functional category for authentication and verification messages.","MARKETING":"Billing or functional category for promotional or marketing messages.","UTILITY":"Billing or functional category for utility and service-related messages."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Works if status template is DRAFT or it was rejected with INCORRECT_CATEGORY."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateInputCategoryEnum"}]},"allowCategoryChange":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Works if status template is DRAFT or it was rejected with INCORRECT_CATEGORY True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false."},"children":[]}]}]}],"uniqueItems":false},"details":{"description":"'Template input details and information.' Not required for draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappUpdateTemplateDetailsInputDto"}]}}}},"components/schemas/WhatsappCommentTypeEnum":{"id":"components/schemas/WhatsappCommentTypeEnum","kind":"json-schema","title":"WhatsappCommentTypeEnum","data":{"type":"string","const":"CREATED"}},"components/schemas/WhatsappCommentDto":{"id":"components/schemas/WhatsappCommentDto","kind":"json-schema","title":"WhatsappCommentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"CREATED":"Indicates the comment has been successfully created and published."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCommentTypeEnum"}]},"comment":{"type":"string","uniqueItems":false},"created":{"type":"string","uniqueItems":false}},"required":["type","comment"]}},"components/schemas/WhatsappCommentInputDto":{"id":"components/schemas/WhatsappCommentInputDto","kind":"json-schema","title":"WhatsappCommentInputDto","data":{"type":"object","properties":{"comment":{"type":"string","minLength":1,"maxLength":65535,"uniqueItems":false}},"required":["comment"]}},"components/schemas/WhatsappTemplateNotificationTypeEnum":{"id":"components/schemas/WhatsappTemplateNotificationTypeEnum","kind":"json-schema","title":"WhatsappTemplateNotificationTypeEnum","data":{"type":"string","enum":["COMMENT_ADDED","CREATED","DRAFT","EDITED","IN_PROGRESS","REJECTED"]}},"components/schemas/WhatsappTemplateNotificationDto":{"id":"components/schemas/WhatsappTemplateNotificationDto","kind":"json-schema","title":"WhatsappTemplateNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created.","DRAFT":"The notification configuration is currently in a draft state.","EDITED":"The notification configuration has been edited or updated.","IN_PROGRESS":"The notification process is currently executing.","REJECTED":"The notification configuration has been rejected."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappTemplateNotificationListDto":{"id":"components/schemas/WhatsappTemplateNotificationListDto","kind":"json-schema","title":"WhatsappTemplateNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/WhatsappTemplateCompareBlockReasonsEnum":{"id":"components/schemas/WhatsappTemplateCompareBlockReasonsEnum","kind":"json-schema","title":"WhatsappTemplateCompareBlockReasonsEnum","data":{"type":"string","enum":["NO_LONGER_NEEDED","NO_REASON","NO_REASON_GIVEN","NO_SIGN_UP","OFFENSIVE_MESSAGES","OTHER","OTP_DID_NOT_REQUEST","SPAM","UNKNOWN_BLOCK_REASON","UNRECOGNIZED"],"description":"Block reason"}},"components/schemas/WhatsappTemplateCompareIdentifierDto":{"id":"components/schemas/WhatsappTemplateCompareIdentifierDto","kind":"json-schema","title":"WhatsappTemplateCompareIdentifierDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Template name","uniqueItems":false},"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ES_UY":"The language configuration is set to Uruguayan Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguagesEnum"}]},"blockOrder":{"type":"number","description":"Order of block rate","uniqueItems":false},"messageSends":{"type":"number","description":"Message send number","uniqueItems":false},"topBlockReason":{"x-enumDescriptions":{"NO_LONGER_NEEDED":"Indicates the end-user opted out because the communication sequence lost relevance to them.","NO_REASON":"Indicates the explicit feedback metrics lack a categorized block reason.","NO_REASON_GIVEN":"Indicates the end-user executed a standard block gesture without submitting survey criteria.","NO_SIGN_UP":"Indicates the end-user reported a potential compliance breach, claiming they never provided authorization opt-in.","OFFENSIVE_MESSAGES":"Indicates the end-user flagged the message payload as malicious, abusive, or inappropriate.","OTHER":"Indicates the block reason submitted by the recipient falls outside the standard platform choices.","OTP_DID_NOT_REQUEST":"Indicates a security or delivery anomaly where the recipient intercepted an unrequested secure authentication token.","SPAM":"Indicates the recipient explicitly reported the messaging flow to the carrier as junk telemetry.","UNKNOWN_BLOCK_REASON":"The explicit rationale behind the recipient block gesture cannot be determined.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Block reason","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateCompareBlockReasonsEnum"}]}},"required":["name","language","blockOrder","messageSends","topBlockReason"]}},"components/schemas/WhatsappTemplateCompareDto":{"id":"components/schemas/WhatsappTemplateCompareDto","kind":"json-schema","title":"WhatsappTemplateCompareDto","data":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateCompareIdentifierDto"},"description":"List of templates","uniqueItems":false}},"required":["templates"]}},"components/schemas/WhatsappInputTemplateCompareIdentifierDto":{"id":"components/schemas/WhatsappInputTemplateCompareIdentifierDto","kind":"json-schema","title":"WhatsappInputTemplateCompareIdentifierDto","data":{"type":"object","properties":{"templateName":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]*[a-z0-9]$","description":"Template name","uniqueItems":false},"templateLanguage":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ES_UY":"The language configuration is set to Uruguayan Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappTemplateLanguagesEnum"}]}},"required":["templateName","templateLanguage"]}},"components/schemas/WhatsappInputTemplateCompareTimeframesEnum":{"id":"components/schemas/WhatsappInputTemplateCompareTimeframesEnum","kind":"json-schema","title":"WhatsappInputTemplateCompareTimeframesEnum","data":{"type":"string","enum":["30","60","7","90"],"description":"Timeframes are limited to 7, 30, 60 and 90 day lookbacks from the time of the request"}},"components/schemas/WhatsappInputTemplateCompareDto":{"id":"components/schemas/WhatsappInputTemplateCompareDto","kind":"json-schema","title":"WhatsappInputTemplateCompareDto","data":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappInputTemplateCompareIdentifierDto"},"minItems":1,"maxItems":1,"description":"List of templates","uniqueItems":false},"timeframe":{"x-enumDescriptions":{"7":"Configures the aggregation engine to contrast metrics over a rolling 7-day interval.","30":"Configures the aggregation engine to contrast metrics over a rolling 30-day interval.","60":"Configures the aggregation engine to contrast metrics over a rolling 60-day interval.","90":"Configures the aggregation engine to contrast metrics over a rolling 90-day interval."},"default":"7","description":"Timeframes are limited to 7, 30, 60 and 90 day lookbacks from the time of the request","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputTemplateCompareTimeframesEnum"}]},"endTimestamp":{"type":"number","format":"timestamp","description":"End of timeframe (default: now)","uniqueItems":false}},"required":["templates"]}},"components/schemas/WhatsappSenderDto":{"id":"components/schemas/WhatsappSenderDto","kind":"json-schema","title":"WhatsappSenderDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sender.","uniqueItems":false},"state":{"x-enumDescriptions":{"ACTIVE":"The sender identity is active and ready to dispatch messages.","IN_PROGRESS":"The configuration or provisioning sequence for the sender identity is currently in progress.","INACTIVE":"The sender identity exists within the system but is currently not active.","PENDING_VERIFICATION":"The sender identity awaits completion of the formal verification and compliance loop.","SUSPENDED":"The sender identity has been temporarily suspended due to administrative or policy restrictions.","ERROR":"The sender identity has encountered an operational failure and requires technical troubleshooting."},"description":"The current state of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderStatesEnum"}]},"changes":{"description":"Any pending changes to the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderChangesDto"}]},"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderDetailsDto"}]},"metadata":{"description":"Data about the current state of individual sender fields.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetadataDto"}]},"region":{"x-enumDescriptions":{"BR":"Specifies that the bot infrastructure should be hosted within the Brazil region.","EU":"Specifies that the bot infrastructure should be hosted within the Europe region.","US":"Specifies that the bot infrastructure should be hosted within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderBotRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa.","UNSPECIFIED":"The Meta data storage residency location is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Region sender store the data in Meta.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetaLocalStoragesEnum"}]},"conversationApiApp":{"type":"string","description":"If set, the Conversation API App ID the sender is connected to.","deprecated":true,"uniqueItems":false},"conversationApiAppDetails":{"description":"If set, the details of the Conversation API App the sender is connected to.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappConversationApiAppDto"}]},"maxTps":{"type":"number","description":"Maximum sender TPS.","uniqueItems":false},"qualityRating":{"x-enumDescriptions":{"GREEN":"Indicates an optimal quality tier with low user block rates and high delivery reliability compliance.","RED":"Indicates a degraded quality tier with severe block rates, forcing active delivery throttling or profile suspension.","YELLOW":"Indicates a warning quality tier reflecting increased end-user complaints or delivery metric fluctuations.","UNKNOWN":"The underlying message quality evaluation history metrics are currently unavailable.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Current quality rating of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappQualityRatingEnum"}]},"dailyLimit":{"x-enumDescriptions":{"NOT_SET":"The daily messaging threshold tier has not been assigned.","TIER_100K":"Restricts outbound traffic up to 100,000 business-initiated conversations per rolling 24-hour cycle.","TIER_10K":"Restricts outbound traffic up to 10,000 business-initiated conversations per rolling 24-hour cycle.","TIER_1K":"Restricts outbound traffic up to 1,000 business-initiated conversations per rolling 24-hour cycle.","TIER_250":"Restricts outbound traffic up to 250 business-initiated conversations per rolling 24-hour cycle.","TIER_2K":"Restricts outbound traffic up to 2,000 business-initiated conversations per rolling 24-hour cycle.","TIER_50":"Restricts outbound traffic up to 50 business-initiated conversations per rolling 24-hour cycle.","TIER_UNLIMITED":"No daily throttling thresholds or messaging limit restrictions apply to this profile.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property is deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AccountDto.businessDailyLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Current daily message limit of the sender."},"children":[]}]}]}],"deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappDailyLimitEnum"}]},"bearerToken":{"type":"string","description":"Bearer token of the sender. The bearer token is needed to connect the sender to a Conversation API App.","uniqueItems":false},"cloudApi":{"type":"boolean","description":"True if the sender is hosted in WhatsApp Cloud API.","deprecated":true,"uniqueItems":false},"created":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was created.","uniqueItems":false},"modified":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was last modified.","uniqueItems":false},"countryCode":{"type":"string","description":"Country code of sender phone number.","uniqueItems":false},"phoneNumber":{"type":"string","description":"Sender phone number without country code.","uniqueItems":false},"numberProvider":{"x-enumDescriptions":{"CUSTOMER":"The communication channel routes traffic using a customer-owned and customer-hosted network node.","SINCH":"The communication channel routes traffic using a system-provided and system-provisioned network node.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Provider for phone number.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderNumberProviderTypeEnum"}]},"businessManager":{"x-enumDescriptions":{"SINCH_AMERICA":"Associates the profile configuration with the Sinch America Meta Business Manager account.","SINCH_BR":"Associates the profile configuration with the Sinch Brazil Meta Business Manager account.","SINCH_MX":"Associates the profile configuration with the Sinch Mexico Meta Business Manager account.","SINCH_SEP":"Associates the profile configuration with the Sinch SEP Meta Business Manager account.","SINCH_UK":"Associates the profile configuration with the Sinch UK Meta Business Manager account.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappBusinessManagersEnum"}]},"wabaBanState":{"x-enumDescriptions":{"DISABLE":"The WhatsApp Business Account has been disabled due to administrative or policy enforcement.","REINSTATE":"The WhatsApp Business Account has been successfully reinstated and cleared of restrictions.","SCHEDULE_FOR_DISABLE":"The WhatsApp Business Account is scheduled for automatic disablement following a grace or appeal period.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Please use get account endpoint for this information.","deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWabaBanStatesEnum"}]},"wabaBanDate":{"type":"string","description":"Please use get account endpoint for this information.","deprecated":true,"uniqueItems":false},"compatibleRegions":{"type":"array","x-enumDescriptions":{"br":"The messaging applications and session contexts are hosted within the Brazil region.","eu":"The messaging applications and session contexts are hosted within the Europe region.","us":"The messaging applications and session contexts are hosted within the United States region."},"uniqueItems":true,"description":"Conversation API app regions the sender can be used for.","items":{"$ref":"#/components/schemas/WhatsappConversationAppRegionsEnum"}}},"required":["id","region","metaLocalStorage","cloudApi","businessManager","compatibleRegions"]}},"components/schemas/WhatsappSenderListDto":{"id":"components/schemas/WhatsappSenderListDto","kind":"json-schema","title":"WhatsappSenderListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"senders":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappSenderDto"}}},"required":["totalSize","pageSize","senders"]}},"components/schemas/WhatsappSenderInputRegionEnum":{"id":"components/schemas/WhatsappSenderInputRegionEnum","kind":"json-schema","title":"WhatsappSenderInputRegionEnum","data":{"type":"string","enum":["BR","EU","US"],"description":"Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used."}},"components/schemas/WhatsappSenderInputMetaLocalStoragesEnum":{"id":"components/schemas/WhatsappSenderInputMetaLocalStoragesEnum","kind":"json-schema","title":"WhatsappSenderInputMetaLocalStoragesEnum","data":{"type":"string","enum":["AE","AU","BH","BR","CA","CH","DE","GB","ID","IN","JP","KR","SG","US","ZA"],"description":"Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used."}},"components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum":{"id":"components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum","kind":"json-schema","title":"WhatsappInputBusinessManagersPublicDocumentationEnum","data":{"type":"string","enum":["SINCH_BR","SINCH_MX","SINCH_UK"],"description":"Business manager."}},"components/schemas/WhatsappSenderInputEsDto":{"id":"components/schemas/WhatsappSenderInputEsDto","kind":"json-schema","title":"WhatsappSenderInputEsDto","data":{"type":"object","properties":{"region":{"x-enumDescriptions":{"BR":"Specifies that the sender operations should be initialized within the Brazil region.","EU":"Specifies that the sender operations should be initialized within the Europe region.","US":"Specifies that the sender operations should be initialized within the United States region."},"description":"Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa."},"description":"Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum"}]},"wabaId":{"type":"string","description":"WhatsApp Business Account that will be connected to the created sender. If left empty, we will try to find the WhatsApp Business Account using your projectId.","uniqueItems":false},"phoneNumberId":{"type":"string","description":"Phone number ID linked to the WhatsApp Business Account.","uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_BR":"Instructs the interface layer to reference public onboarding documentation for the Brazil Meta Business Manager asset.","SINCH_MX":"Instructs the interface layer to reference public onboarding documentation for the Mexico Meta Business Manager asset.","SINCH_UK":"Instructs the interface layer to reference public onboarding documentation for the United Kingdom Meta Business Manager asset."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum"}]},"authenticationCode":{"type":"string","minLength":1,"description":"Single-use access code.","uniqueItems":false}},"required":["wabaId","phoneNumberId"]}},"components/schemas/WhatsappSenderInputBotRegionEnum":{"id":"components/schemas/WhatsappSenderInputBotRegionEnum","kind":"json-schema","title":"WhatsappSenderInputBotRegionEnum","data":{"type":"string","enum":["BR","EU","US"],"description":"Region sender is provisioned in."}},"components/schemas/WhatsappInputSenderPhoneProvisioningDetailsDto":{"id":"components/schemas/WhatsappInputSenderPhoneProvisioningDetailsDto","kind":"json-schema","title":"WhatsappInputSenderPhoneProvisioningDetailsDto","data":{"type":"object","properties":{"countryCode":{"type":"string","format":"country code","description":"Country code of sender phone number.","uniqueItems":false},"phoneNumber":{"type":"string","format":"numeric phone number","maxLength":32,"description":"Sender phone number without country code.","uniqueItems":false},"displayName":{"type":"string","minLength":1,"maxLength":128,"description":"Sender display name within WhatsApp.","uniqueItems":false}},"required":["countryCode","phoneNumber","displayName"]}},"components/schemas/WhatsappInputSenderPhoneProvisioningDto":{"id":"components/schemas/WhatsappInputSenderPhoneProvisioningDto","kind":"json-schema","title":"WhatsappInputSenderPhoneProvisioningDto","data":{"type":"object","properties":{"region":{"x-enumDescriptions":{"BR":"Specifies that the bot execution layer should be provisioned within the Brazil region.","EU":"Specifies that the bot execution layer should be provisioned within the Europe region.","US":"Specifies that the bot execution layer should be provisioned within the United States region."},"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputBotRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa."},"description":"Region sender store the data in Meta.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum"}]},"details":{"description":"Sender input details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputSenderPhoneProvisioningDetailsDto"}]}},"required":["details"]}},"components/schemas/WhatsappSenderInputNumberProviderTypeEnum":{"id":"components/schemas/WhatsappSenderInputNumberProviderTypeEnum","kind":"json-schema","title":"WhatsappSenderInputNumberProviderTypeEnum","data":{"type":"string","enum":["CUSTOMER","SINCH"],"description":"If the phone number is provided by Sinch or the customer."}},"components/schemas/WhatsappInputSenderPartnerInitiatedDetailsDto":{"id":"components/schemas/WhatsappInputSenderPartnerInitiatedDetailsDto","kind":"json-schema","title":"WhatsappInputSenderPartnerInitiatedDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":128,"description":"Sender display name within WhatsApp.","uniqueItems":false},"description":{"type":"string","minLength":1,"maxLength":512,"description":"Description of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false},"vertical":{"x-enumDescriptions":{"ALCOHOL":"Configures the sender profile for a brand operating within the alcohol sector.","AUTOMOTIVE":"Configures the sender profile for a brand operating within the automotive sector.","BEAUTY_SPA_SALON":"Configures the sender profile for a brand operating within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"Configures the sender profile for a brand operating within clothing and apparel commerce.","EDUCATION":"Configures the sender profile for a brand operating within the education field.","ENTERTAINMENT":"Configures the sender profile for a brand operating within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"Configures the sender profile for a brand operating within event planning and corporate services.","FINANCE_AND_BANKING":"Configures the sender profile for a brand operating within financial and banking services.","FOOD_AND_GROCERY":"Configures the sender profile for a brand operating within the food supply or grocery sector.","HOTEL_AND_LODGING":"Configures the sender profile for a brand operating within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"Configures the sender profile for a brand operating within healthcare or medical services.","NON_PROFIT":"Configures the sender profile for a registered non-profit organization.","ONLINE_GAMBLING":"Configures the sender profile for a brand operating within the online gambling or betting industry.","OTC_DRUGS":"Configures the sender profile for a brand operating within over-the-counter drug sales and distribution.","OTHER":"Configures the sender profile for an industry operating outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"Configures the sender profile for a brand operating within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"Configures the sender profile for a brand providing corporate, professional, or technical services.","PUBLIC_SERVICE":"Configures the sender profile for a brand providing public utilities or governmental services.","RESTAURANT":"Configures the sender profile for a brand operating a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"Configures the sender profile for a brand operating within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"Configures the sender profile for a brand operating within transportation, travel, or logistics services."},"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputWhatsAppVerticalEnum"}]},"email":{"type":"string","format":"email","maxLength":128,"description":"Contact email displayed in the Business Info within WhatsApp.","uniqueItems":false},"address":{"type":"string","minLength":1,"maxLength":256,"description":"Business address displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteOne":{"type":"string","format":"url","maxLength":256,"description":"Business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteTwo":{"type":"string","format":"url","maxLength":256,"description":"Second business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"about":{"type":"string","minLength":1,"maxLength":139,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"About text displayed in the Business Info within WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hyperlinks can be included but will not render as clickable links."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markdown is not supported."},"children":[]}]}]}]}],"uniqueItems":false},"photoUrl":{"type":"string","format":"url","maxLength":256,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the sender image displayed in WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 5MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 192 x 192 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum image dimensions: 640 x 640 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image will be cropped to maximum image dimensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit a PNG image with a transparent background, the background will be rendered as black."},"children":[]}]}]}]}],"uniqueItems":false},"countryCode":{"type":"string","format":"country code","description":"Numeric telephone country codes (eg. 48 for PL, 44 for UK).","uniqueItems":false},"phoneNumber":{"type":"string","format":"numeric phone number","maxLength":32,"description":"Numeric phone number without numeric country code eg. 444555666. Cannot exist already such a sender with that phone number.\nIf provided by Sinch.","uniqueItems":false}},"required":["displayName","vertical","countryCode"]}},"components/schemas/WhatsappInputSenderPartnerInitiatedDto":{"id":"components/schemas/WhatsappInputSenderPartnerInitiatedDto","kind":"json-schema","title":"WhatsappInputSenderPartnerInitiatedDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"description":"Create as draft or submit. Defaults to submit.","default":"SUBMIT","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappActionsEnum"}]},"region":{"x-enumDescriptions":{"BR":"Specifies that the bot execution layer should be provisioned within the Brazil region.","EU":"Specifies that the bot execution layer should be provisioned within the Europe region.","US":"Specifies that the bot execution layer should be provisioned within the United States region."},"description":"Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputBotRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa."},"description":"Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum"}]},"phoneNumberProvider":{"x-enumDescriptions":{"CUSTOMER":"Configures the sender to route traffic via a customer-owned and customer-hosted telephony network node.","SINCH":"Configures the sender to route traffic via an allocated, system-provided network node layer."},"description":"If the phone number is provided by Sinch or the customer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputNumberProviderTypeEnum"}]},"saveDraftOnFailure":{"type":"boolean","default":false,"description":"Flag to save sender as draft if submission fails. Defaults to false.","uniqueItems":false},"details":{"description":"Sender input details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputSenderPartnerInitiatedDetailsDto"}]}},"required":["phoneNumberProvider","details"]}},"components/schemas/WhatsappSenderInputDetailsDto":{"id":"components/schemas/WhatsappSenderInputDetailsDto","kind":"json-schema","title":"WhatsappSenderInputDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":128,"description":"Sender display name within WhatsApp.","uniqueItems":false},"description":{"type":"string","minLength":1,"maxLength":512,"description":"Description of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false},"vertical":{"x-enumDescriptions":{"ALCOHOL":"Configures the sender profile for a brand operating within the alcohol sector.","AUTOMOTIVE":"Configures the sender profile for a brand operating within the automotive sector.","BEAUTY_SPA_SALON":"Configures the sender profile for a brand operating within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"Configures the sender profile for a brand operating within clothing and apparel commerce.","EDUCATION":"Configures the sender profile for a brand operating within the education field.","ENTERTAINMENT":"Configures the sender profile for a brand operating within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"Configures the sender profile for a brand operating within event planning and corporate services.","FINANCE_AND_BANKING":"Configures the sender profile for a brand operating within financial and banking services.","FOOD_AND_GROCERY":"Configures the sender profile for a brand operating within the food supply or grocery sector.","HOTEL_AND_LODGING":"Configures the sender profile for a brand operating within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"Configures the sender profile for a brand operating within healthcare or medical services.","NON_PROFIT":"Configures the sender profile for a registered non-profit organization.","ONLINE_GAMBLING":"Configures the sender profile for a brand operating within the online gambling or betting industry.","OTC_DRUGS":"Configures the sender profile for a brand operating within over-the-counter drug sales and distribution.","OTHER":"Configures the sender profile for an industry operating outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"Configures the sender profile for a brand operating within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"Configures the sender profile for a brand providing corporate, professional, or technical services.","PUBLIC_SERVICE":"Configures the sender profile for a brand providing public utilities or governmental services.","RESTAURANT":"Configures the sender profile for a brand operating a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"Configures the sender profile for a brand operating within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"Configures the sender profile for a brand operating within transportation, travel, or logistics services."},"description":"Category of the sender displayed in the Business Info within WhatsApp.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputWhatsAppVerticalEnum"}]},"email":{"type":"string","format":"email","maxLength":128,"description":"Contact email displayed in the Business Info within WhatsApp.","uniqueItems":false},"address":{"type":"string","minLength":1,"maxLength":256,"description":"Business address displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteOne":{"type":"string","format":"url","maxLength":256,"description":"Business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"websiteTwo":{"type":"string","format":"url","maxLength":256,"description":"Second business website displayed in the Business Info within WhatsApp.","uniqueItems":false},"about":{"type":"string","minLength":1,"maxLength":139,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"About text displayed in the Business Info within WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hyperlinks can be included but will not render as clickable links."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Markdown is not supported."},"children":[]}]}]}]}],"uniqueItems":false},"photoUrl":{"type":"string","format":"url","maxLength":256,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the sender image displayed in WhatsApp."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/webp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 5MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 192 x 192 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum image dimensions: 640 x 640 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image will be cropped to maximum image dimensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you submit a PNG image with a transparent background, the background will be rendered as black."},"children":[]}]}]}]}],"uniqueItems":false}},"required":["displayName","vertical"]}},"components/schemas/WhatsappSenderInputDtoDeprecated":{"id":"components/schemas/WhatsappSenderInputDtoDeprecated","kind":"json-schema","title":"WhatsappSenderInputDtoDeprecated","data":{"type":"object","properties":{"region":{"x-enumDescriptions":{"BR":"Specifies that the sender operations should be initialized within the Brazil region.","EU":"Specifies that the sender operations should be initialized within the Europe region.","US":"Specifies that the sender operations should be initialized within the United States region."},"description":"Region sender is provisioned in. If not provided, default region for the country set in the billing account will be used. For partner-initiated accounts, the value set for WhatsApp account will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa."},"description":"Region sender store the data in Meta. If not provided, the default value set for the chosen region will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum"}]},"businessManager":{"x-enumDescriptions":{"SINCH_BR":"Instructs the interface layer to reference public onboarding documentation for the Brazil Meta Business Manager asset.","SINCH_MX":"Instructs the interface layer to reference public onboarding documentation for the Mexico Meta Business Manager asset.","SINCH_UK":"Instructs the interface layer to reference public onboarding documentation for the United Kingdom Meta Business Manager asset."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum"}]},"wabaId":{"type":"string","description":"WhatsApp Business Account that will be connected to the created sender. If left empty, we will try to find the WhatsApp Business Account using your projectId.","uniqueItems":false},"phoneNumberId":{"type":"string","description":"Phone number ID linked to the WhatsApp Business Account.","uniqueItems":false},"facebookAccessToken":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long-Lived User access token. Mandatory if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebookCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"uniqueItems":false},"facebookCode":{"type":"string","format":"uri","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-use access code. Mandatory if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebookAccessToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"uniqueItems":false},"name":{"type":"string","minLength":1,"maxLength":128,"description":"Sender name.","uniqueItems":false},"details":{"description":"Sender input details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputDetailsDto"}]}},"description":"SenderInputDto is deprecated. Please use SenderInputEsDto.","required":["name","details"]}},"components/schemas/WhatsappSenderRegistrationMethodEnum":{"id":"components/schemas/WhatsappSenderRegistrationMethodEnum","kind":"json-schema","title":"WhatsappSenderRegistrationMethodEnum","data":{"type":"string","enum":["SMS","VOICE","UNRECOGNIZED"],"description":"Registration Method of the sender."}},"components/schemas/WhatsappSenderRegisterDto":{"id":"components/schemas/WhatsappSenderRegisterDto","kind":"json-schema","title":"WhatsappSenderRegisterDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sender.","uniqueItems":false},"method":{"x-enumDescriptions":{"SMS":"The registration sequence utilizes immediate SMS verification protocols.","VOICE":"The registration sequence utilizes automated voice-call verification protocols.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Registration Method of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderRegistrationMethodEnum"}]},"accepted":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was accepted.","uniqueItems":false},"verificationCodeSent":{"type":"boolean","description":"Whether the verification code has been sent.","uniqueItems":false}},"required":["id","method","accepted","verificationCodeSent"]}},"components/schemas/WhatsappSenderInputRegistrationMethodEnum":{"id":"components/schemas/WhatsappSenderInputRegistrationMethodEnum","kind":"json-schema","title":"WhatsappSenderInputRegistrationMethodEnum","data":{"type":"string","enum":["SMS","VOICE"],"description":"Registration Method of the sender."}},"components/schemas/WhatsappSenderInputRegisterDto":{"id":"components/schemas/WhatsappSenderInputRegisterDto","kind":"json-schema","title":"WhatsappSenderInputRegisterDto","data":{"type":"object","properties":{"method":{"x-enumDescriptions":{"SMS":"The registration sequence utilizes immediate SMS verification protocols.","VOICE":"The registration sequence utilizes automated voice-call verification protocols."},"description":"Registration Method of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputRegistrationMethodEnum"}]}},"required":["method"]}},"components/schemas/WhatsappSenderInputVerifyDto":{"id":"components/schemas/WhatsappSenderInputVerifyDto","kind":"json-schema","title":"WhatsappSenderInputVerifyDto","data":{"type":"object","properties":{"code":{"type":"string","format":"otp","examples":["123456"],"description":"OTP code used for sender verification. Must be exactly 6 characters with no spaces. Not required if the sender number is already verified by Meta.","uniqueItems":false}}}},"components/schemas/WhatsappSenderNotificationTypeEnum":{"id":"components/schemas/WhatsappSenderNotificationTypeEnum","kind":"json-schema","title":"WhatsappSenderNotificationTypeEnum","data":{"type":"string","enum":["ACTIVE","COMMENT_ADDED","CREATED","DRAFT","EDITED","ERROR","IN_PROGRESS","INACTIVE","REGISTERED","REJECTED","VERIFIED"]}},"components/schemas/WhatsappSenderNotificationDto":{"id":"components/schemas/WhatsappSenderNotificationDto","kind":"json-schema","title":"WhatsappSenderNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"ACTIVE":"The notification configuration is active and enabled.","COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created.","DRAFT":"The notification configuration is currently in a draft state.","EDITED":"The notification configuration has been edited or updated.","ERROR":"An operational error occurred within the notification flow.","IN_PROGRESS":"The notification process is currently executing.","INACTIVE":"The notification configuration is inactive or disabled.","REGISTERED":"The notification configuration has been registered successfully.","REJECTED":"The notification configuration has been rejected.","VERIFIED":"The notification setup has been verified successfully."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappSenderNotificationListDto":{"id":"components/schemas/WhatsappSenderNotificationListDto","kind":"json-schema","title":"WhatsappSenderNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSenderNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/WhatsappSuggestedUsernamesDto":{"id":"components/schemas/WhatsappSuggestedUsernamesDto","kind":"json-schema","title":"WhatsappSuggestedUsernamesDto","data":{"type":"object","properties":{"usernames":{"description":"List of suggested usernames for the sender.","uniqueItems":false,"type":"array","items":{"type":"string"}}},"required":["usernames"]}},"components/schemas/WhatsappSolutionDetailsDto":{"id":"components/schemas/WhatsappSolutionDetailsDto","kind":"json-schema","title":"WhatsappSolutionDetailsDto","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the solution.","uniqueItems":false}},"required":["name"]}},"components/schemas/WhatsappSolutionMetaAppDto":{"id":"components/schemas/WhatsappSolutionMetaAppDto","kind":"json-schema","title":"WhatsappSolutionMetaAppDto","data":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"description":"The unique ID of the Meta App.","uniqueItems":false},"name":{"type":"string","readOnly":true,"description":"The name of the Meta App.","uniqueItems":false}},"required":["id","name"]}},"components/schemas/WhatsappSolutionDto":{"id":"components/schemas/WhatsappSolutionDto","kind":"json-schema","title":"WhatsappSolutionDto","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"The unique ID of the solution","uniqueItems":false},"details":{"description":"Solution details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSolutionDetailsDto"}]},"partnerApp":{"readOnly":true,"description":"The Meta App of the Tech Provider.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSolutionMetaAppDto"}]},"ownerApp":{"readOnly":true,"description":"The Meta App of the Solution Partner (e.g. Sinch).","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSolutionMetaAppDto"}]},"assigned":{"type":"boolean","readOnly":true,"description":"If project has been assigned to this solution.","uniqueItems":false}},"required":["id","details","assigned"]}},"components/schemas/WhatsappFailedSolutionErrorsEnum":{"id":"components/schemas/WhatsappFailedSolutionErrorsEnum","kind":"json-schema","title":"WhatsappFailedSolutionErrorsEnum","data":{"type":"string","enum":["ACTIVATION_FAILED","CREATION_FAILED","UNRECOGNIZED"],"description":"Error code allows to programmatically handle errors."}},"components/schemas/WhatsappFailedSolutionDto":{"id":"components/schemas/WhatsappFailedSolutionDto","kind":"json-schema","title":"WhatsappFailedSolutionDto","data":{"type":"object","properties":{"partnerAppId":{"type":"string","readOnly":true,"description":"The unique ID of the Tech Provider Meta App.","uniqueItems":false},"errorCode":{"x-enumDescriptions":{"ACTIVATION_FAILED":"The background execution layout failed during the software solution initialization phase.","CREATION_FAILED":"The infrastructure provisioning engine failed during the primary solution instantiation loop.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"readOnly":true,"description":"Error code allows to programmatically handle errors.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappFailedSolutionErrorsEnum"}]},"errorMessage":{"type":"string","readOnly":true,"description":"Human readable message.","uniqueItems":false}},"required":["partnerAppId","errorCode"]}},"components/schemas/WhatsappCreateSolutionListDto":{"id":"components/schemas/WhatsappCreateSolutionListDto","kind":"json-schema","title":"WhatsappCreateSolutionListDto","data":{"type":"object","properties":{"solutions":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSolutionDto"},"description":"List of solutions.","uniqueItems":false},"failedSolutions":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappFailedSolutionDto"},"description":"List of failed solutions.","uniqueItems":false}},"required":["solutions","failedSolutions"]}},"components/schemas/WhatsappSolutionDetailsInputDto":{"id":"components/schemas/WhatsappSolutionDetailsInputDto","kind":"json-schema","title":"WhatsappSolutionDetailsInputDto","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the solution.","uniqueItems":false}},"required":["name"]}},"components/schemas/WhatsappSolutionInputDto":{"id":"components/schemas/WhatsappSolutionInputDto","kind":"json-schema","title":"WhatsappSolutionInputDto","data":{"type":"object","properties":{"details":{"description":"Solution details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSolutionDetailsInputDto"}]},"accessToken":{"type":"string","description":"The accessToken received from the authResponse, returned when completing the embedded solution flow.","uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_BR":"Instructs the interface layer to reference public onboarding documentation for the Brazil Meta Business Manager asset.","SINCH_MX":"Instructs the interface layer to reference public onboarding documentation for the Mexico Meta Business Manager asset.","SINCH_UK":"Instructs the interface layer to reference public onboarding documentation for the United Kingdom Meta Business Manager asset."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersPublicDocumentationEnum"}]}},"required":["details","accessToken","businessManager"]}},"components/schemas/WhatsappSolutionListDto":{"id":"components/schemas/WhatsappSolutionListDto","kind":"json-schema","title":"WhatsappSolutionListDto","data":{"type":"object","properties":{"solutions":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSolutionDto"},"description":"List of solutions.","uniqueItems":false}},"required":["solutions"]}},"components/schemas/WhatsappWabaNumbersDto":{"id":"components/schemas/WhatsappWabaNumbersDto","kind":"json-schema","title":"WhatsappWabaNumbersDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the number.","uniqueItems":false},"displayPhoneNumber":{"type":"string","description":"The number displayed in E.164 format.","uniqueItems":false},"provisioned":{"type":"boolean","description":"True if the number is available for usage, false otherwise.","uniqueItems":false}},"required":["id","displayPhoneNumber","provisioned"]}},"components/schemas/WhatsappWabaDetailsDto":{"id":"components/schemas/WhatsappWabaDetailsDto","kind":"json-schema","title":"WhatsappWabaDetailsDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the WhatsApp Business Account.","uniqueItems":false},"numbers":{"description":"The numbers that are shared to the WhatsApp Business Account.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappWabaNumbersDto"}}},"required":["id","numbers"]}},"components/schemas/WhatsappWabaDetailsListDto":{"id":"components/schemas/WhatsappWabaDetailsListDto","kind":"json-schema","title":"WhatsappWabaDetailsListDto","data":{"type":"object","properties":{"wabas":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappWabaDetailsDto"}}},"required":["wabas"]}},"components/schemas/WhatsappInputBusinessManagersEnum":{"id":"components/schemas/WhatsappInputBusinessManagersEnum","kind":"json-schema","title":"WhatsappInputBusinessManagersEnum","data":{"type":"string","enum":["SINCH_AMERICA","SINCH_BR","SINCH_MX","SINCH_SEP","SINCH_UK"],"description":"Business manager."}},"components/schemas/WhatsappWabaDetailsListInputDto":{"id":"components/schemas/WhatsappWabaDetailsListInputDto","kind":"json-schema","title":"WhatsappWabaDetailsListInputDto","data":{"type":"object","properties":{"facebookToken":{"type":"string","description":"Long-Lived User access token.","uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_AMERICA":"Associates the input configuration with the Sinch America Meta Business Manager account.","SINCH_BR":"Associates the input configuration with the Sinch Brazil Meta Business Manager account.","SINCH_MX":"Associates the input configuration with the Sinch Mexico Meta Business Manager account.","SINCH_SEP":"Associates the input configuration with the Sinch SEP Meta Business Manager account.","SINCH_UK":"Associates the input configuration with the Sinch UK Meta Business Manager account."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersEnum"}]}},"required":["facebookToken"]}},"components/schemas/WhatsappLongLivedAccessTokenDto":{"id":"components/schemas/WhatsappLongLivedAccessTokenDto","kind":"json-schema","title":"WhatsappLongLivedAccessTokenDto","data":{"type":"object","properties":{"longLivedAccessToken":{"type":"string","uniqueItems":false}},"required":["longLivedAccessToken"]}},"components/schemas/WhatsappLongLivedAccessTokenInputDto":{"id":"components/schemas/WhatsappLongLivedAccessTokenInputDto","kind":"json-schema","title":"WhatsappLongLivedAccessTokenInputDto","data":{"type":"object","properties":{"facebookToken":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long-Lived User access token. Mandatory if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebookCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"uniqueItems":false},"facebookCode":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-use access code. Mandatory if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebookToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_AMERICA":"Associates the input configuration with the Sinch America Meta Business Manager account.","SINCH_BR":"Associates the input configuration with the Sinch Brazil Meta Business Manager account.","SINCH_MX":"Associates the input configuration with the Sinch Mexico Meta Business Manager account.","SINCH_SEP":"Associates the input configuration with the Sinch SEP Meta Business Manager account.","SINCH_UK":"Associates the input configuration with the Sinch UK Meta Business Manager account."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersEnum"}]}}}},"components/schemas/WhatsappInputAccountWhatsAppVerticalsEnum":{"id":"components/schemas/WhatsappInputAccountWhatsAppVerticalsEnum","kind":"json-schema","title":"WhatsappInputAccountWhatsAppVerticalsEnum","data":{"type":"string","enum":["ALCOHOL","AUTOMOTIVE","BEAUTY_SPA_SALON","CLOTHING_AND_APPAREL","EDUCATION","ENTERTAINMENT","EVENT_PLANNING_AND_SERVICE","FINANCE_AND_BANKING","FOOD_AND_GROCERY","HOTEL_AND_LODGING","MEDICAL_AND_HEALTH","NON_PROFIT","OTC_DRUGS","OTHER","PHYSICAL_GAMBLING","PROFESSIONAL_SERVICES","PUBLIC_SERVICE","RESTAURANT","SHOPPING_AND_RETAIL","TRAVEL_AND_TRANSPORTATION"],"description":"Vertical / business category for the business account."}},"components/schemas/WhatsappInputAccountSenderRelatedDetailsDto":{"id":"components/schemas/WhatsappInputAccountSenderRelatedDetailsDto","kind":"json-schema","title":"WhatsappInputAccountSenderRelatedDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":255,"description":"Waba display name / used as default display name of new phone at Meta","uniqueItems":false},"businessCategory":{"x-enumDescriptions":{"ALCOHOL":"Configures the account profile for a brand operating within the alcohol sector.","AUTOMOTIVE":"Configures the account profile for a brand operating within the automotive sector.","BEAUTY_SPA_SALON":"Configures the account profile for a brand operating within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"Configures the account profile for a brand operating within clothing and apparel commerce.","EDUCATION":"Configures the account profile for a brand operating within the education field.","ENTERTAINMENT":"Configures the account profile for a brand operating within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"Configures the account profile for a brand operating within event planning and corporate services.","FINANCE_AND_BANKING":"Configures the account profile for a brand operating within financial and banking services.","FOOD_AND_GROCERY":"Configures the account profile for a brand operating within the food supply or grocery sector.","HOTEL_AND_LODGING":"Configures the account profile for a brand operating within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"Configures the account profile for a brand operating within healthcare or medical services.","NON_PROFIT":"Configures the account profile for a registered non-profit organization.","OTC_DRUGS":"Configures the account profile for a brand operating within over-the-counter drug sales and distribution.","OTHER":"Configures the account profile for an industry operating outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"Configures the account profile for a brand operating within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"Configures the account profile for a brand providing corporate, professional, or technical services.","PUBLIC_SERVICE":"Configures the account profile for a brand providing public utilities or governmental services.","RESTAURANT":"Configures the account profile for a brand operating a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"Configures the account profile for a brand operating within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"Configures the account profile for a brand operating within transportation, travel, or logistics services."},"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputAccountWhatsAppVerticalsEnum"}]},"region":{"x-enumDescriptions":{"BR":"Specifies that the sender operations should be initialized within the Brazil region.","EU":"Specifies that the sender operations should be initialized within the Europe region.","US":"Specifies that the sender operations should be initialized within the United States region."},"description":"Region sender will be provisioned in. If not provided, default region for the country set in the billing account will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa."},"description":"Region Meta will store data in Meta. If not provided, the default value set for the chosen region will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum"}]}},"required":["displayName","businessCategory"]}},"components/schemas/WhatsappInputAccountPartnerInitiatedDto":{"id":"components/schemas/WhatsappInputAccountPartnerInitiatedDto","kind":"json-schema","title":"WhatsappInputAccountPartnerInitiatedDto","data":{"type":"object","properties":{"wabaName":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id=<your_business_manager_id> Ensure that the name shown exactly matches the one you enter here."},"children":[]}]}]}],"uniqueItems":false},"clientBusinessManagerId":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name."},"children":[]}]}]}],"uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_AMERICA":"Associates the input configuration with the Sinch America Meta Business Manager account.","SINCH_BR":"Associates the input configuration with the Sinch Brazil Meta Business Manager account.","SINCH_MX":"Associates the input configuration with the Sinch Mexico Meta Business Manager account.","SINCH_SEP":"Associates the input configuration with the Sinch SEP Meta Business Manager account.","SINCH_UK":"Associates the input configuration with the Sinch UK Meta Business Manager account."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersEnum"}]},"senderDetails":{"description":"Details of the sender to be created.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputAccountSenderRelatedDetailsDto"}]}},"required":["wabaName","clientBusinessManagerId","senderDetails"]}},"components/schemas/WhatsappInputAccountDtoDeprecated":{"id":"components/schemas/WhatsappInputAccountDtoDeprecated","kind":"json-schema","title":"WhatsappInputAccountDtoDeprecated","data":{"type":"object","properties":{"clientBusinessManagerId":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name."},"children":[]}]}]}],"uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_AMERICA":"Associates the input configuration with the Sinch America Meta Business Manager account.","SINCH_BR":"Associates the input configuration with the Sinch Brazil Meta Business Manager account.","SINCH_MX":"Associates the input configuration with the Sinch Mexico Meta Business Manager account.","SINCH_SEP":"Associates the input configuration with the Sinch SEP Meta Business Manager account.","SINCH_UK":"Associates the input configuration with the Sinch UK Meta Business Manager account."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputBusinessManagersEnum"}]},"companyLegalName":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id=<your_business_manager_id> Ensure that the name shown exactly matches the one you enter here."},"children":[]}]}]}],"uniqueItems":false}},"description":"InputAccountDto is deprecated as Meta officially has declared End-Of-Life (EOL) of OBO on September 30, 2025.","required":["clientBusinessManagerId","companyLegalName"]}},"components/schemas/WhatsappAccountStateEnum":{"id":"components/schemas/WhatsappAccountStateEnum","kind":"json-schema","title":"WhatsappAccountStateEnum","data":{"type":"string","enum":["ONBOARDED","PENDING_FACEBOOK_VERIFICATION","REJECTED"],"description":"The current state of your account."}},"components/schemas/WhatsappAccountSenderRelatedDetailsDto":{"id":"components/schemas/WhatsappAccountSenderRelatedDetailsDto","kind":"json-schema","title":"WhatsappAccountSenderRelatedDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","description":"Waba display name / used as default display name of new phone at Meta","uniqueItems":false},"businessCategory":{"x-enumDescriptions":{"ALCOHOL":"The brand operates within the alcohol sector.","AUTOMOTIVE":"The brand operates within the automotive sector.","BEAUTY_SPA_SALON":"The brand operates within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"The brand operates within clothing and apparel commerce.","EDUCATION":"The brand operates within the education field.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"The brand operates within event planning and corporate services.","FINANCE_AND_BANKING":"The brand operates within financial and banking services.","FOOD_AND_GROCERY":"The brand operates within the food supply or grocery sector.","HOTEL_AND_LODGING":"The brand operates within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"The brand operates within healthcare, medical services, or pharmaceuticals.","NON_PROFIT":"The brand is a registered non-profit organization.","NOT_SET":"The operational business vertical has not been selected.","ONLINE_GAMBLING":"The brand operates within the online gambling or betting industry.","OTC_DRUGS":"The brand operates within over-the-counter drug sales and distribution.","OTHER":"The brand operates in an industry outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"The brand operates within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"The brand provides corporate, professional, or technical services.","PUBLIC_SERVICE":"The brand provides public utilities or governmental services.","RESTAURANT":"The brand operates a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"The brand operates within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"The brand operates within transportation, travel, or logistics services.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVerticalEnum"}]},"region":{"x-enumDescriptions":{"BR":"Specifies that the bot infrastructure should be hosted within the Brazil region.","EU":"Specifies that the bot infrastructure should be hosted within the Europe region.","US":"Specifies that the bot infrastructure should be hosted within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderBotRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa.","UNSPECIFIED":"The Meta data storage residency location is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Local storage region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetaLocalStoragesEnum"}]}},"required":["displayName","businessCategory","region","metaLocalStorage"]}},"components/schemas/WhatsappAccountDetailsDto":{"id":"components/schemas/WhatsappAccountDetailsDto","kind":"json-schema","title":"WhatsappAccountDetailsDto","data":{"type":"object","properties":{"clientBusinessManagerId":{"type":"string","description":"The Business Manager ID for the client.","uniqueItems":false},"companyLegalName":{"type":"string","deprecated":true,"description":"The registered name of the brand who will be engaging with their users.","uniqueItems":false},"wabaName":{"type":"string","description":"The registered name of the brand who will be engaging with their users.","uniqueItems":false},"senderDetails":{"description":"Details of the sender firstly created.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountSenderRelatedDetailsDto"}]}},"required":["clientBusinessManagerId","wabaName"]}},"components/schemas/WhatsappAccountSenderRelatedChangesDetailsDto":{"id":"components/schemas/WhatsappAccountSenderRelatedChangesDetailsDto","kind":"json-schema","title":"WhatsappAccountSenderRelatedChangesDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":255,"description":"Waba display name / used as default display name of new phone at Meta","uniqueItems":false},"businessCategory":{"x-enumDescriptions":{"ALCOHOL":"The brand operates within the alcohol sector.","AUTOMOTIVE":"The brand operates within the automotive sector.","BEAUTY_SPA_SALON":"The brand operates within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"The brand operates within clothing and apparel commerce.","EDUCATION":"The brand operates within the education field.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"The brand operates within event planning and corporate services.","FINANCE_AND_BANKING":"The brand operates within financial and banking services.","FOOD_AND_GROCERY":"The brand operates within the food supply or grocery sector.","HOTEL_AND_LODGING":"The brand operates within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"The brand operates within healthcare, medical services, or pharmaceuticals.","NON_PROFIT":"The brand is a registered non-profit organization.","NOT_SET":"The operational business vertical has not been selected.","ONLINE_GAMBLING":"The brand operates within the online gambling or betting industry.","OTC_DRUGS":"The brand operates within over-the-counter drug sales and distribution.","OTHER":"The brand operates in an industry outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"The brand operates within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"The brand provides corporate, professional, or technical services.","PUBLIC_SERVICE":"The brand provides public utilities or governmental services.","RESTAURANT":"The brand operates a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"The brand operates within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"The brand operates within transportation, travel, or logistics services.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderWhatsAppVerticalEnum"}]},"region":{"x-enumDescriptions":{"BR":"Specifies that the bot infrastructure should be hosted within the Brazil region.","EU":"Specifies that the bot infrastructure should be hosted within the Europe region.","US":"Specifies that the bot infrastructure should be hosted within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderBotRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa.","UNSPECIFIED":"The Meta data storage residency location is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Local storage region for the partner-initiated sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderMetaLocalStoragesEnum"}]}},"required":["displayName","businessCategory","region","metaLocalStorage"]}},"components/schemas/WhatsappAccountChangesDetailsDto":{"id":"components/schemas/WhatsappAccountChangesDetailsDto","kind":"json-schema","title":"WhatsappAccountChangesDetailsDto","data":{"type":"object","properties":{"clientBusinessManagerId":{"type":"string","description":"The Business Manager ID for the client.","uniqueItems":false},"companyLegalName":{"type":"string","deprecated":true,"description":"The registered name of the brand who will be engaging with their users.","uniqueItems":false},"wabaName":{"type":"string","description":"The registered name of the brand who will be engaging with their users.","uniqueItems":false},"senderDetails":{"description":"Details of the sender firstly created.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountSenderRelatedChangesDetailsDto"}]}}}},"components/schemas/WhatsappAccountChangeStateEnum":{"id":"components/schemas/WhatsappAccountChangeStateEnum","kind":"json-schema","title":"WhatsappAccountChangeStateEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","PENDING_FACEBOOK_VERIFICATION","REJECTED"],"description":"Current status of the pending changes."}},"components/schemas/WhatsappAccountChangesDto":{"id":"components/schemas/WhatsappAccountChangesDto","kind":"json-schema","title":"WhatsappAccountChangesDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"The modifications to the account profile are saved as a draft only.","IN_PROGRESS":"The modifications to the account profile have been submitted and are still processing.","PENDING_FACEBOOK_VERIFICATION":"The modifications to the account profile await completed Facebook business verification workflows.","REJECTED":"The modifications to the account profile have been reviewed and rejected."},"description":"Current status of the pending changes.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountChangeStateEnum"}]},"details":{"anyOf":[{"$ref":"#/components/schemas/WhatsappAccountDetailsDto","description":"For newly created account"},{"$ref":"#/components/schemas/WhatsappAccountChangesDetailsDto","description":"For update account"}],"description":"The pending changes to account details and information","uniqueItems":false}},"required":["status"]}},"components/schemas/WhatsappAccountDto":{"id":"components/schemas/WhatsappAccountDto","kind":"json-schema","title":"WhatsappAccountDto","data":{"type":"object","properties":{"state":{"x-enumDescriptions":{"ONBOARDED":"The onboarding sequence is complete, and the channels linked to the account are active.","PENDING_FACEBOOK_VERIFICATION":"The account setup awaits completed Facebook business verification workflows.","REJECTED":"The account profile registration or verification sequence was reviewed and rejected."},"description":"The current state of your account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountStateEnum"}]},"isEmbeddedSignup":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the Account was created through Embedded Signup. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}],"uniqueItems":false},"businessManager":{"x-enumDescriptions":{"SINCH_AMERICA":"Associates the profile configuration with the Sinch America Meta Business Manager account.","SINCH_BR":"Associates the profile configuration with the Sinch Brazil Meta Business Manager account.","SINCH_MX":"Associates the profile configuration with the Sinch Mexico Meta Business Manager account.","SINCH_SEP":"Associates the profile configuration with the Sinch SEP Meta Business Manager account.","SINCH_UK":"Associates the profile configuration with the Sinch UK Meta Business Manager account.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Business manager.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappBusinessManagersEnum"}]},"wabaId":{"type":"string","description":"WhatsApp Business Manager ID.","uniqueItems":false},"changes":{"description":"Any pending changes to the account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountChangesDto"}]},"details":{"description":"Account details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountDetailsDto"}]},"wabaBanState":{"x-enumDescriptions":{"DISABLE":"The WhatsApp Business Account has been disabled due to administrative or policy enforcement.","REINSTATE":"The WhatsApp Business Account has been successfully reinstated and cleared of restrictions.","SCHEDULE_FOR_DISABLE":"The WhatsApp Business Account is scheduled for automatic disablement following a grace or appeal period.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Ban state when account has been banned.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWabaBanStatesEnum"}]},"wabaBanDate":{"type":"string","description":"The UTC Date Time in ISO 8601 for when account has been banned.","uniqueItems":false},"wabaEnabledForInsights":{"type":"boolean","description":"Template analytics status for account.","uniqueItems":false},"wabaEnabledForDirectSend":{"type":"boolean","description":"Direct Send API status for account.","uniqueItems":false},"wabaMaxPriceOnboarded":{"type":"boolean","description":"Indicates whether the account has the maximum price feature enabled.","uniqueItems":false},"compatibleRegions":{"type":"array","x-enumDescriptions":{"br":"The messaging applications and session contexts are hosted within the Brazil region.","eu":"The messaging applications and session contexts are hosted within the Europe region.","us":"The messaging applications and session contexts are hosted within the United States region."},"uniqueItems":true,"description":"Conversation API app regions the sender can be used for.","items":{"$ref":"#/components/schemas/WhatsappConversationAppRegionsEnum"}},"primaryBusinessLocation":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AQ":"The country code for Antarctica.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Two-letter country code in ISO 3166 standard, specifying the country where business is based","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappCountryCodesEnum"}]},"partnerInitiatedRequestId":{"type":"string","deprecated":true,"description":"Deprecated. This field is retained for backward compatibility and is always returned as undefined.","uniqueItems":false},"businessDailyLimit":{"x-enumDescriptions":{"NOT_SET":"The daily messaging threshold tier has not been assigned.","TIER_100K":"Restricts outbound traffic up to 100,000 business-initiated conversations per rolling 24-hour cycle.","TIER_10K":"Restricts outbound traffic up to 10,000 business-initiated conversations per rolling 24-hour cycle.","TIER_1K":"Restricts outbound traffic up to 1,000 business-initiated conversations per rolling 24-hour cycle.","TIER_250":"Restricts outbound traffic up to 250 business-initiated conversations per rolling 24-hour cycle.","TIER_2K":"Restricts outbound traffic up to 2,000 business-initiated conversations per rolling 24-hour cycle.","TIER_50":"Restricts outbound traffic up to 50 business-initiated conversations per rolling 24-hour cycle.","TIER_UNLIMITED":"No daily throttling thresholds or messaging limit restrictions apply to this profile.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Current daily message limit of the account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappDailyLimitEnum"}]},"currency":{"type":"string","description":"The currency code for the account.","uniqueItems":false}},"required":["isEmbeddedSignup","businessManager","wabaMaxPriceOnboarded","compatibleRegions"]}},"components/schemas/WhatsappInputAccountSenderRelatedUpdateDetailsDto":{"id":"components/schemas/WhatsappInputAccountSenderRelatedUpdateDetailsDto","kind":"json-schema","title":"WhatsappInputAccountSenderRelatedUpdateDetailsDto","data":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":255,"description":"Waba display name / used as default display name of new phone at Meta","uniqueItems":false},"businessCategory":{"x-enumDescriptions":{"ALCOHOL":"Configures the account profile for a brand operating within the alcohol sector.","AUTOMOTIVE":"Configures the account profile for a brand operating within the automotive sector.","BEAUTY_SPA_SALON":"Configures the account profile for a brand operating within beauty, spa, or salon services.","CLOTHING_AND_APPAREL":"Configures the account profile for a brand operating within clothing and apparel commerce.","EDUCATION":"Configures the account profile for a brand operating within the education field.","ENTERTAINMENT":"Configures the account profile for a brand operating within the entertainment and media industry.","EVENT_PLANNING_AND_SERVICE":"Configures the account profile for a brand operating within event planning and corporate services.","FINANCE_AND_BANKING":"Configures the account profile for a brand operating within financial and banking services.","FOOD_AND_GROCERY":"Configures the account profile for a brand operating within the food supply or grocery sector.","HOTEL_AND_LODGING":"Configures the account profile for a brand operating within hospitality, hotels, or lodging.","MEDICAL_AND_HEALTH":"Configures the account profile for a brand operating within healthcare or medical services.","NON_PROFIT":"Configures the account profile for a registered non-profit organization.","OTC_DRUGS":"Configures the account profile for a brand operating within over-the-counter drug sales and distribution.","OTHER":"Configures the account profile for an industry operating outside the standard defined taxonomy.","PHYSICAL_GAMBLING":"Configures the account profile for a brand operating within physical gambling establishments or casinos.","PROFESSIONAL_SERVICES":"Configures the account profile for a brand providing corporate, professional, or technical services.","PUBLIC_SERVICE":"Configures the account profile for a brand providing public utilities or governmental services.","RESTAURANT":"Configures the account profile for a brand operating a restaurant or food service establishment.","SHOPPING_AND_RETAIL":"Configures the account profile for a brand operating within retail or wholesale commerce.","TRAVEL_AND_TRANSPORTATION":"Configures the account profile for a brand operating within transportation, travel, or logistics services."},"description":"Vertical / business category for the business account.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputAccountWhatsAppVerticalsEnum"}]},"region":{"x-enumDescriptions":{"BR":"Specifies that the sender operations should be initialized within the Brazil region.","EU":"Specifies that the sender operations should be initialized within the Europe region.","US":"Specifies that the sender operations should be initialized within the United States region."},"description":"Region sender will be provisioned in. If not provided, default region for the country set in the billing account will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputRegionEnum"}]},"metaLocalStorage":{"x-enumDescriptions":{"AE":"Specifies that Meta-managed user and compliance data should be stored within the United Arab Emirates.","AU":"Specifies that Meta-managed user and compliance data should be stored within Australia.","BH":"Specifies that Meta-managed user and compliance data should be stored within Bahrain.","BR":"Specifies that Meta-managed user and compliance data should be stored within Brazil.","CA":"Specifies that Meta-managed user and compliance data should be stored within Canada.","CH":"Specifies that Meta-managed user and compliance data should be stored within Switzerland.","DE":"Specifies that Meta-managed user and compliance data should be stored within Germany.","GB":"Specifies that Meta-managed user and compliance data should be stored within the United Kingdom.","ID":"Specifies that Meta-managed user and compliance data should be stored within Indonesia.","IN":"Specifies that Meta-managed user and compliance data should be stored within India.","JP":"Specifies that Meta-managed user and compliance data should be stored within Japan.","KR":"Specifies that Meta-managed user and compliance data should be stored within South Korea.","SG":"Specifies that Meta-managed user and compliance data should be stored within Singapore.","US":"Specifies that Meta-managed user and compliance data should be stored within the United States.","ZA":"Specifies that Meta-managed user and compliance data should be stored within South Africa."},"description":"Region Meta will store data in Meta. If not provided, the default value set for the chosen region will be used.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappSenderInputMetaLocalStoragesEnum"}]}}}},"components/schemas/WhatsappInputUpdateAccountDto":{"id":"components/schemas/WhatsappInputUpdateAccountDto","kind":"json-schema","title":"WhatsappInputUpdateAccountDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","deprecated":true,"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id=<your_business_manager_id> Ensure that the name shown exactly matches the one you enter here."},"children":[]}]}]}],"uniqueItems":false},"wabaName":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registered name of the brand who will be engaging with their users needs to be specified. This name must match the name associated with the Facebook Business Manager ID below. You can verify the registered name by visiting: https://business.facebook.com/select/?business_id=<your_business_manager_id> Ensure that the name shown exactly matches the one you enter here."},"children":[]}]}]}],"uniqueItems":false},"clientBusinessManagerId":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Business Manager ID for the client to create the account. This can be found in the Meta Business Manager in Business Settings > Business Info below the Business Manager Account Name."},"children":[]}]}]}],"uniqueItems":false},"senderDetails":{"description":"Details of the sender to be created.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappInputAccountSenderRelatedUpdateDetailsDto"}]}}}},"components/schemas/WhatsappAccountNotificationTypeEnum":{"id":"components/schemas/WhatsappAccountNotificationTypeEnum","kind":"json-schema","title":"WhatsappAccountNotificationTypeEnum","data":{"type":"string","enum":["COMMENT_ADDED","CREATED","DRAFT","EDITED","IN_PROGRESS","PENDING_FACEBOOK_VERIFICATION","REJECTED"]}},"components/schemas/WhatsappAccountNotificationDto":{"id":"components/schemas/WhatsappAccountNotificationDto","kind":"json-schema","title":"WhatsappAccountNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created.","DRAFT":"The notification configuration is currently in a draft state.","EDITED":"The notification configuration has been edited or updated.","IN_PROGRESS":"The notification process is currently executing.","PENDING_FACEBOOK_VERIFICATION":"The notification setup is pending Facebook account verification.","REJECTED":"The notification configuration has been rejected."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappAccountNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/WhatsappAccountNotificationListDto":{"id":"components/schemas/WhatsappAccountNotificationListDto","kind":"json-schema","title":"WhatsappAccountNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappAccountNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/WhatsappWhatsAppFlowStatusesEnum":{"id":"components/schemas/WhatsappWhatsAppFlowStatusesEnum","kind":"json-schema","title":"WhatsappWhatsAppFlowStatusesEnum","data":{"type":"string","enum":["FLOW_STATUS_DEPRECATED","FLOW_STATUS_DRAFT","FLOW_STATUS_PUBLISHED","UNRECOGNIZED"],"description":"Flow status."}},"components/schemas/WhatsappFlowDto":{"id":"components/schemas/WhatsappFlowDto","kind":"json-schema","title":"WhatsappFlowDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the flow.","uniqueItems":false},"name":{"type":"string","description":"Name of the flow.","uniqueItems":false},"status":{"x-enumDescriptions":{"FLOW_STATUS_DEPRECATED":"The structured interaction flow is deprecated and restricted from future deployment triggers.","FLOW_STATUS_DRAFT":"The structured interaction flow configuration is saved as an unsubmitted draft.","FLOW_STATUS_PUBLISHED":"The structured interaction flow has been published and is active for active production routing.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Flow status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/WhatsappWhatsAppFlowStatusesEnum"}]}},"required":["id","name","status"]}},"components/schemas/WhatsappFlowListDto":{"id":"components/schemas/WhatsappFlowListDto","kind":"json-schema","title":"WhatsappFlowListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"flows":{"description":"List of flows in the WABA linked to the project.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappFlowDto"}}},"required":["totalSize","pageSize","flows"]}},"components/schemas/WhatsappFlowScreenDto":{"id":"components/schemas/WhatsappFlowScreenDto","kind":"json-schema","title":"WhatsappFlowScreenDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the screen which works as a page url.","uniqueItems":false}},"required":["id"]}},"components/schemas/WhatsappFlowScreenListDto":{"id":"components/schemas/WhatsappFlowScreenListDto","kind":"json-schema","title":"WhatsappFlowScreenListDto","data":{"type":"object","properties":{"screens":{"description":"List of screens for flow.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/WhatsappFlowScreenDto"}}},"required":["screens"]}},"components/schemas/BundlesSubprojectInputDto":{"id":"components/schemas/BundlesSubprojectInputDto","kind":"json-schema","title":"BundlesSubprojectInputDto","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of subproject to create. If not set, will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from root object. If neither this value or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the root is set, then the request will fail."},"children":[]}]}]}],"minLength":1,"maxLength":255,"uniqueItems":false},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"\nOptional labels to attach to the subproject. If provided must be an object with string keys and string values.\n","uniqueItems":false}}}},"components/schemas/BundlesInputBundlesSmsAppDto":{"id":"components/schemas/BundlesInputBundlesSmsAppDto","kind":"json-schema","title":"BundlesInputBundlesSmsAppDto","data":{"type":"object","properties":{"test":{"type":"boolean","default":false,"deprecated":true,"description":"Deprecated. This field is no longer used and will be removed in a future release.","uniqueItems":false},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of SMS App to create. If not set, will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from root object. If neither this value or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the root is set, then the request will fail."},"children":[]}]}]}],"minLength":1,"maxLength":255,"uniqueItems":false}}}},"components/schemas/BundlesWebhooksInputWebhookTriggerEnum":{"id":"components/schemas/BundlesWebhooksInputWebhookTriggerEnum","kind":"json-schema","title":"BundlesWebhooksInputWebhookTriggerEnum","data":{"type":"string","enum":["BATCH_DELIVERY_REPORT_FULL","BATCH_DELIVERY_REPORT_SUMMARY","BATCH_STATUS_UPDATE","BILLING_CREDIT_LIMIT_BREACHED","CAPABILITY","CHANNEL_EVENT","CONSENT_BATCH_COMPLETE","CONTACT_CREATE","CONTACT_DELETE","CONTACT_IDENTITIES_DUPLICATION","CONTACT_MERGE","CONTACT_UPDATE","CONVERSATION_DELETE","CONVERSATION_START","CONVERSATION_STOP","EVENT_DELIVERY","EVENT_INBOUND","MESSAGE_DELIVERY","MESSAGE_INBOUND","MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION","MESSAGE_SUBMIT","OPT_IN","OPT_OUT","RECORD_NOTIFICATION","SMART_CONVERSATION","UNSUPPORTED"],"description":"An array of triggers that should trigger the webhook and result in an event being sent to the target url."}},"components/schemas/BundlesInputWebhookTargetTypesEnum":{"id":"components/schemas/BundlesInputWebhookTargetTypesEnum","kind":"json-schema","title":"BundlesInputWebhookTargetTypesEnum","data":{"type":"string","enum":["DISMISS","GRPC","HTTP"],"description":"Conversation API webhook target type."}},"components/schemas/BundlesConversationAppWebhooksInputDto":{"id":"components/schemas/BundlesConversationAppWebhooksInputDto","kind":"json-schema","title":"BundlesConversationAppWebhooksInputDto","data":{"type":"object","properties":{"target":{"type":"string","maxLength":742,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target url where events should be sent to. The conversation-api.*.sinch.com subdomains are forbidden."},"children":[]}]}]}],"uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BATCH_DELIVERY_REPORT_FULL":"Triggers when a complete batch delivery report payload is ready for dispatch.","BATCH_DELIVERY_REPORT_SUMMARY":"Triggers when a summary representation of a batch delivery report is generated.","BATCH_STATUS_UPDATE":"Triggers when the general state of a message batch updates.","BILLING_CREDIT_LIMIT_BREACHED":"Triggers when the associated account breaches its pre-configured billing credit boundary.","CAPABILITY":"Triggers when the operational capabilities of a target contact identity are updated.","CHANNEL_EVENT":"Triggers when an isolated event occurs on an active communication channel.","CONSENT_BATCH_COMPLETE":"Triggers when the bulk processing configuration for user consent data completes execution.","CONTACT_CREATE":"Triggers when a completely new contact identity profile is registered.","CONTACT_DELETE":"Triggers when an existing contact identity profile is removed from storage.","CONTACT_IDENTITIES_DUPLICATION":"Triggers when identical unique fields are detected across multiple customer records.","CONTACT_MERGE":"Triggers when independent user identity footprints consolidate into a single record.","CONTACT_UPDATE":"Triggers when specific configuration attributes on a profile are updated.","CONVERSATION_DELETE":"Triggers when an active or historic interaction footprint is purged from log data.","CONVERSATION_START":"Triggers when a fresh interaction loop initializes with a target identity.","CONVERSATION_STOP":"Triggers when an ongoing session loop explicitly terminates or expires.","EVENT_DELIVERY":"Triggers when a system or channel action event is successfully dispatched to the target.","EVENT_INBOUND":"Triggers when an external system or user action payload enters the API processing cycle.","MESSAGE_DELIVERY":"Triggers when a communication text or rich data asset successfully targets the destination node.","MESSAGE_INBOUND":"Triggers when an incoming communication piece from an end-user hits the messaging gateway.","MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION":"Triggers when a message object undergoes automated sensitive data scrubbing prior to ingestion.","MESSAGE_SUBMIT":"Triggers when an explicit delivery request is initially registered by the API ingestion layer.","OPT_IN":"Triggers when a client record submits a confirmation to receive notifications.","OPT_OUT":"Triggers when a client record revokes baseline authorization to receive outbound communication.","RECORD_NOTIFICATION":"Triggers when an internal system audit log changes state.","SMART_CONVERSATION":"Triggers when natural language workflows process automated contextual interaction variables.","UNSUPPORTED":"Triggers when an incoming trigger structure fails validation criteria."},"uniqueItems":true,"maxLength":20,"description":"An array of triggers that should trigger the webhook and result in an event being sent to the target url.","items":{"$ref":"#/components/schemas/BundlesWebhooksInputWebhookTriggerEnum"}},"secret":{"type":"string","description":"Optional secret used to sign contents of webhooks sent by the Conversation API. You can then use the secret to verify the signature.","uniqueItems":false},"targetType":{"x-enumDescriptions":{"DISMISS":"Drops the payload without executing delivery attempts to any destinations.","GRPC":"Routes the payload directly via an active gRPC stream connection.","HTTP":"Dispatches the payload via a standard HTTP POST callback configuration."},"description":"Conversation API webhook target type.","default":"HTTP","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputWebhookTargetTypesEnum"}]}},"required":["target","triggers"]}},"components/schemas/BundlesInputConversationAppConversationRetentionPolicyTypesEnum":{"id":"components/schemas/BundlesInputConversationAppConversationRetentionPolicyTypesEnum","kind":"json-schema","title":"BundlesInputConversationAppConversationRetentionPolicyTypesEnum","data":{"type":"string","enum":["CONVERSATION_EXPIRE_POLICY","MESSAGE_EXPIRE_POLICY","PERSIST_RETENTION_POLICY"],"description":"\nConversation API conversation retention policy type.\n    "}},"components/schemas/BundlesConversationAppConversationRetentionPolicyInputDto":{"id":"components/schemas/BundlesConversationAppConversationRetentionPolicyInputDto","kind":"json-schema","title":"BundlesConversationAppConversationRetentionPolicyInputDto","data":{"type":"object","properties":{"retentionPolicyType":{"x-enumDescriptions":{"CONVERSATION_EXPIRE_POLICY":"Specifies that the entire conversation expires after the configured retention period.","MESSAGE_EXPIRE_POLICY":"Specifies that individual messages expire after the configured retention period.","PERSIST_RETENTION_POLICY":"Specifies that conversation data is retained indefinitely until it is explicitly removed."},"description":"\nConversation API conversation retention policy type.\n    ","default":"MESSAGE_EXPIRE_POLICY","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppConversationRetentionPolicyTypesEnum"}]},"ttl":{"type":"number","minimum":1,"maximum":3650,"description":"\nConversation API conversation retention time in days.\n    ","default":180,"uniqueItems":false}}}},"components/schemas/BundlesInputConversationAppDispatchRetentionPolicyTypesEnum":{"id":"components/schemas/BundlesInputConversationAppDispatchRetentionPolicyTypesEnum","kind":"json-schema","title":"BundlesInputConversationAppDispatchRetentionPolicyTypesEnum","data":{"type":"string","const":"MESSAGE_EXPIRE_POLICY","description":"\nConversation API dispatch retention policy type.\n    "}},"components/schemas/BundlesConversationAppDispatchRetentionPolicyInputDto":{"id":"components/schemas/BundlesConversationAppDispatchRetentionPolicyInputDto","kind":"json-schema","title":"BundlesConversationAppDispatchRetentionPolicyInputDto","data":{"type":"object","properties":{"retentionPolicyType":{"x-enumDescriptions":{"MESSAGE_EXPIRE_POLICY":"Specifies that dispatched messages expire after the configured retention period."},"description":"\nConversation API dispatch retention policy type.\n    ","default":"MESSAGE_EXPIRE_POLICY","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppDispatchRetentionPolicyTypesEnum"}]},"ttl":{"type":"number","minimum":0,"maximum":7,"description":"\nConversation API dispatch retention time in days.\n    ","default":7,"uniqueItems":false}}}},"components/schemas/BundlesInputConversationAppProcessingModesEnum":{"id":"components/schemas/BundlesInputConversationAppProcessingModesEnum","kind":"json-schema","title":"BundlesInputConversationAppProcessingModesEnum","data":{"type":"string","enum":["CONVERSATION","DISPATCH"],"description":"\nConversation API processing mode. May be changed later by using Conversation App API.\n    "}},"components/schemas/BundlesInputConversationAppConsentManagerSettingsModesEnum":{"id":"components/schemas/BundlesInputConversationAppConsentManagerSettingsModesEnum","kind":"json-schema","title":"BundlesInputConversationAppConsentManagerSettingsModesEnum","data":{"type":"string","enum":["DISABLED","PRIMARY","SECONDARY"],"description":"\nConversation API consent manager settings mode.\n    "}},"components/schemas/BundlesConversationAppConsentManagerSettingsInputDto":{"id":"components/schemas/BundlesConversationAppConsentManagerSettingsInputDto","kind":"json-schema","title":"BundlesConversationAppConsentManagerSettingsInputDto","data":{"type":"object","properties":{"mode":{"x-enumDescriptions":{"DISABLED":"The consent manager integration is disabled.","PRIMARY":"The consent manager utilizes the primary data governance tracking mode.","SECONDARY":"The consent manager utilizes the secondary data governance fallback tracking mode."},"description":"\nConversation API consent manager settings mode.\n    ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppConsentManagerSettingsModesEnum"}]}},"required":["mode"]}},"components/schemas/BundlesConversationAppInputDto":{"id":"components/schemas/BundlesConversationAppInputDto","kind":"json-schema","title":"BundlesConversationAppInputDto","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of Conversation API App to create. If not set, will use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from root object. If neither this value or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the root is set, then the request will fail."},"children":[]}]}]}],"minLength":1,"maxLength":255,"uniqueItems":false},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/BundlesConversationAppWebhooksInputDto"},"maxItems":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversation API webhooks to create for the new App. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Webhooks/#tag/Webhooks/operation/Webhooks_CreateWebhook"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversation API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all options."},"children":[]}]}]}],"uniqueItems":false},"processingMode":{"x-enumDescriptions":{"CONVERSATION":"Messages are processed using conversational logic, maintaining context and state.","DISPATCH":"Messages are processed using fire-and-forget dispatch logic without active state management."},"description":"\nConversation API processing mode. May be changed later by using Conversation App API.\n    ","default":"DISPATCH","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesInputConversationAppProcessingModesEnum"}]},"retentionPolicy":{"oneOf":[{"$ref":"#/components/schemas/BundlesConversationAppConversationRetentionPolicyInputDto","description":"\nRetention policy in CONVERSATION mode.\n        "},{"$ref":"#/components/schemas/BundlesConversationAppDispatchRetentionPolicyInputDto","description":"\nRetention policy in DISPATCH mode.\n        "}],"description":"\nConversation API retention policy for messages and conversations. May be changed later by using Conversation App API.\n    ","uniqueItems":false},"consentManagerSettings":{"description":"Conversation API consent manager settings.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppConsentManagerSettingsInputDto"}]}}}},"components/schemas/BundlesWebhookTriggersEnum":{"id":"components/schemas/BundlesWebhookTriggersEnum","kind":"json-schema","title":"BundlesWebhookTriggersEnum","data":{"type":"string","enum":["ALL","BUNDLE_DONE","KAKAOTALK_SENDER_ACTIVE","KAKAOTALK_SENDER_COMMENT_ADDED","KAKAOTALK_SENDER_INACTIVE","KAKAOTALK_SENDER_REJECTED","KAKAOTALK_TEMPLATE_APPROVED","KAKAOTALK_TEMPLATE_COMMENT_ADDED","KAKAOTALK_TEMPLATE_REJECTED","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED","RCS_SENDER_COMMENT_ADDED","RCS_SENDER_OPERATOR_STATUS_UPDATED","RCS_SENDER_STATUS_UPDATED","RCS_ACCOUNT_COMMENT_ADDED","WHATSAPP_ACCOUNT_COMMENT_ADDED","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED","WHATSAPP_ACCOUNT_ONBOARDED","WHATSAPP_ACCOUNT_PENDING_VERIFICATION","WHATSAPP_ACCOUNT_REJECTED","WHATSAPP_WABA_ACCOUNT_CHANGED","WHATSAPP_SENDER_ACTIVE","WHATSAPP_SENDER_COMMENT_ADDED","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED","WHATSAPP_SENDER_DELETED","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED","WHATSAPP_SENDER_ERROR","WHATSAPP_SENDER_INACTIVE","WHATSAPP_SENDER_PENDING_VERIFICATION","WHATSAPP_SENDER_QUALITY_RATING_CHANGED","WHATSAPP_SENDER_REJECTED","WHATSAPP_SENDER_USERNAME_UPDATED","WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE","WHATSAPP_TEMPLATE_CATEGORY_UPDATED","WHATSAPP_TEMPLATE_COMMENT_ADDED","WHATSAPP_TEMPLATE_DELETED","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED","WHATSAPP_TEMPLATE_REJECTED","WHATSAPP_TEMPLATE_STATUS_UPDATED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of triggers you want to be notified about on your webhook. To be able to listen to all type of events use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUNDLE_DONE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_USERNAME_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Account: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_ONBOARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_WABA_ACCOUNT_CHANGED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RCS Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_OPERATOR_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_REJECTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_REJECTED"},"children":[]}]}]}]}]}},"components/schemas/BundlesWebhookInputDto":{"id":"components/schemas/BundlesWebhookInputDto","kind":"json-schema","title":"BundlesWebhookInputDto","data":{"type":"object","properties":{"target":{"type":"string","description":"A valid target url where events should be sent to.","maxLength":742,"minLength":1,"format":"url","uniqueItems":false},"secret":{"type":"string","description":"Secret to be used to sign contents of webhooks sent by the provisioning API. You can then use the secret to verify the signature. Please not that secret should have a high entropy to be considered secure.","maxLength":128,"minLength":1,"uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BUNDLE_DONE":"Webhook event triggered when a bundle processing flow is completed.","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED":"Webhook event triggered when the RCS brand registration process status changes.","RCS_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS sender.","RCS_SENDER_OPERATOR_STATUS_UPDATED":"Webhook event triggered when an RCS sender operator status changes.","RCS_SENDER_STATUS_UPDATED":"Webhook event triggered when an RCS sender status changes.","RCS_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS account.","KAKAOTALK_SENDER_ACTIVE":"Webhook event triggered when a KakaoTalk sender becomes active.","KAKAOTALK_SENDER_INACTIVE":"Webhook event triggered when a KakaoTalk sender becomes inactive.","KAKAOTALK_SENDER_REJECTED":"Webhook event triggered when a KakaoTalk sender is rejected.","KAKAOTALK_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk sender.","KAKAOTALK_TEMPLATE_APPROVED":"Webhook event triggered when a KakaoTalk template is approved.","KAKAOTALK_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk template.","KAKAOTALK_TEMPLATE_REJECTED":"Webhook event triggered when a KakaoTalk template is rejected.","WHATSAPP_ACCOUNT_ONBOARDED":"Webhook event triggered when a WhatsApp account onboarding is completed.","WHATSAPP_ACCOUNT_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp account is pending verification.","WHATSAPP_ACCOUNT_REJECTED":"Webhook event triggered when a WhatsApp account is rejected.","WHATSAPP_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp account.","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp account daily messaging limit changes.","WHATSAPP_WABA_ACCOUNT_CHANGED":"Webhook event triggered when the linked WhatsApp Business Account changes.","WHATSAPP_SENDER_ACTIVE":"Webhook event triggered when a WhatsApp sender becomes active.","WHATSAPP_SENDER_INACTIVE":"Webhook event triggered when a WhatsApp sender becomes inactive.","WHATSAPP_SENDER_REJECTED":"Webhook event triggered when a WhatsApp sender is rejected.","WHATSAPP_SENDER_DELETED":"Webhook event triggered when a WhatsApp sender is deleted.","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED":"Webhook event triggered when a WhatsApp sender display name is updated.","WHATSAPP_SENDER_ERROR":"Webhook event triggered when a WhatsApp sender enters an error state.","WHATSAPP_SENDER_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp sender is pending verification.","WHATSAPP_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp sender.","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp sender daily messaging limit changes.","WHATSAPP_SENDER_QUALITY_RATING_CHANGED":"Webhook event triggered when a WhatsApp sender quality rating changes.","WHATSAPP_SENDER_USERNAME_UPDATED":"Webhook event triggered when a WhatsApp sender username is updated.","WHATSAPP_TEMPLATE_APPROVED":"Webhook event triggered when a WhatsApp template is approved.","WHATSAPP_TEMPLATE_REJECTED":"Webhook event triggered when a WhatsApp template is rejected.","WHATSAPP_TEMPLATE_DELETED":"Webhook event triggered when a WhatsApp template is deleted.","WHATSAPP_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp template.","WHATSAPP_TEMPLATE_STATUS_UPDATED":"Webhook event triggered when a WhatsApp template status changes.","WHATSAPP_TEMPLATE_CATEGORY_UPDATED":"Webhook event triggered when a WhatsApp template category changes.","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE":"Webhook event triggered when a future WhatsApp template category update is scheduled.","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED":"Webhook event triggered when a WhatsApp template quality score changes.","ALL":"Webhook event triggered for all supported events."},"uniqueItems":true,"minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of triggers you want to be notified about on your webhook. To be able to listen to all type of events use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bundles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUNDLE_DONE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_USERNAME_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp Account: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_ONBOARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_WABA_ACCOUNT_CHANGED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RCS Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_OPERATOR_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_STATUS_UPDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_REJECTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KakaoTalk Template: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_REJECTED"},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/BundlesWebhookTriggersEnum"}}},"required":["target","secret","triggers"]}},"components/schemas/BundlesBundlesInputRegionEnum":{"id":"components/schemas/BundlesBundlesInputRegionEnum","kind":"json-schema","title":"BundlesBundlesInputRegionEnum","data":{"type":"string","enum":["BR","EU","US"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region to create resources in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Allowed values for staging environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"components/schemas/BundlesInputBundlesDto":{"id":"components/schemas/BundlesInputBundlesDto","kind":"json-schema","title":"BundlesInputBundlesDto","data":{"type":"object","properties":{"name":{"type":"string","examples":["Sample bundle"],"description":"Name of bundle to create. If a name is not specified in the resource blocks then they will be created with this name.","minLength":1,"maxLength":255,"uniqueItems":false},"region":{"x-enumDescriptions":{"BR":"Specifies that the resources should be provisioned within the Brazil region.","EU":"Specifies that the resources should be provisioned within the Europe region.","US":"Specifies that the resources should be provisioned within the United States region."},"example":"US","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region to create resources in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Allowed values for staging environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesBundlesInputRegionEnum"}]},"subproject":{"oneOf":[{"$ref":"#/components/schemas/BundlesSubprojectInputDto"},{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use default values. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit to not create a subproject."},"children":[]}]}]}]}],"example":true,"description":"\nSubproject resource block.\n\nIf set to true, a subproject will be created under the provided projectId with default name from the root object. Optionally a different name can be specified as well as labels on the project.\n\nIf not provided or set to false, a subproject will not be created and instead all resources will be created under the projectId provided in the request.\n  ","uniqueItems":false},"smsApp":{"oneOf":[{"$ref":"#/components/schemas/BundlesInputBundlesSmsAppDto"},{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use default values. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit to not create an SMS app."},"children":[]}]}]}]}],"example":true,"description":"\nSMS Application resource block.\n\nIf set to true, an SMS Application will be created under the project or subproject specified. Optionally a different name can specified.\n\nIf not provided or set to false, an SMS Application will not be created.\n  ","uniqueItems":false},"convApp":{"oneOf":[{"$ref":"#/components/schemas/BundlesConversationAppInputDto"},{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use default values. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit to not create a Conversation API app."},"children":[]}]}]}]}],"example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversation Application resource block."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, a Conversation Application will be created under the project or subproject specified. All other resources created will be associated with the Conversation Application."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally a different name can specified as well as Conversation API webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided or set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a Conversation Application will not be created."},"children":[]}]}]}],"uniqueItems":false},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/BundlesWebhookInputDto"},"uniqueItems":true,"minItems":1,"maxItems":15,"description":"\nWebhook targets for the Provisioning API.\n  \nField 'target' must have unique values across items.\n  "}},"required":["region"]}},"components/schemas/BundlesBundleServicesStateEnum":{"id":"components/schemas/BundlesBundleServicesStateEnum","kind":"json-schema","title":"BundlesBundleServicesStateEnum","data":{"type":"string","enum":["DONE","FAILED","IN_PROGRESS"],"description":"Current state."}},"components/schemas/BundlesHttpStatusCodeEnum":{"id":"components/schemas/BundlesHttpStatusCodeEnum","kind":"json-schema","title":"BundlesHttpStatusCodeEnum","data":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,425,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}},"components/schemas/BundlesWebhookDeliveryStatusDto":{"id":"components/schemas/BundlesWebhookDeliveryStatusDto","kind":"json-schema","title":"BundlesWebhookDeliveryStatusDto","data":{"type":"object","properties":{"webhookId":{"type":"string","uniqueItems":false},"httpStatusCode":{"x-enumDescriptions":{"100":"The server has received the request headers and the client should proceed to send the request body.","101":"The server understands and is willing to comply with the client request to switch protocols.","102":"The server has received and is processing the request, but no response is available yet.","103":"Returns intermediate response headers before the final HTTP message, primarily used for preloading resources.","200":"The request has succeeded and the payload is returned in the response.","201":"The request has succeeded and a new resource has been successfully created as a result.","202":"The request has been accepted for processing, but the processing has not been completed.","203":"The returned metainformation is not identical to that at the origin server.","204":"The request has succeeded but there is no additional content to send in the response payload.","205":"The server successfully processed the request and requires the client to reset the document view.","206":"The server is successfully delivering part of the resource due to a range header sent by the client.","207":"Provides status for multiple independent operations within a single response message.","208":"The members of a DAV binding have already been enumerated in a previous part of the multi-status response.","226":"The server has completed a GET request for the resource, and the response is a representation of one or more instance-manipulations.","300":"The requested resource has multiple representations, each with its own specific location.","301":"The requested resource has been assigned a new permanent URI and any future references should use this URI.","302":"The requested resource resides temporarily under a different URI.","303":"The server directs the client to get the requested resource at another URI with a GET request.","304":"Indicates that the resource has not been modified since the version specified by the request headers.","305":"The requested resource must be accessed through the proxy given by the location field.","306":"No longer used. Originally intended to direct the client to use a different proxy for subsequent requests.","307":"The requested resource resides temporarily under a different URI, and the client must use the original method.","308":"The requested resource has been assigned a new permanent URI, and the client must retain the original request method.","400":"The server cannot or will not process the request due to something that is perceived to be a client error.","401":"The request requires user authentication. The client must authenticate itself to get the requested response.","402":"Reserved for future use. Originally intended to indicate that digital payment systems are required.","403":"The client does not have access rights to the content; the server is refusing to give the requested resource.","404":"The server cannot find the requested resource or the origin server is willing to hide its existence.","405":"The request method is known by the server but is not supported by the target resource.","406":"The target resource does not have a current representation that would be acceptable to the user agent.","407":"The client must first authenticate itself with the proxy before proceeding.","408":"The server timed out waiting for the client request; the connection was closed without completing the transfer.","409":"The request could not be completed due to a conflict with the current state of the target resource.","410":"The requested resource is no longer available at the server and no forwarding address is known.","411":"The server refuses to accept the request without a defined Content-Length header field.","412":"One or more preconditions given in the request header fields evaluated to false when tested on the server.","413":"The server refuses to process a request because the request payload is larger than the server is willing or able to process.","414":"The server refuses to service the request because the request target URI is longer than the server is willing to interpret.","415":"The origin server refuses to service the request because the payload is in an unsupported format.","416":"The range specified by the Range header field in the request cannot be fulfilled by the server.","417":"The expectation given in the Expect request header field could not be met by at least one inbound server.","418":"The server refuses to brew coffee because it is, permanently, a teapot.","421":"The request was directed at a server that is not able to produce a response for that specific connection.","422":"The server understands the content type and syntax of the request, but was unable to process the contained instructions.","423":"The source or destination resource of a method is locked and cannot be modified.","424":"The method could not be performed because the requested action depended on another action that failed.","425":"The server is unwilling to risk processing a request that might be replayed during a TLS early data attack.","426":"The server refuses to perform the request using the current protocol but might do so after the client upgrades to a different protocol.","428":"The origin server requires the request to be conditional to avoid race conditions.","429":"The user has sent too many requests in a given amount of time, exceeding the rate limits.","431":"The server is unwilling to process the request because its header fields are too large.","451":"The user agent requested a resource that cannot legally be provided, such as a website blocked by a government.","500":"The server encountered an unexpected condition that prevented it from fulfilling the request.","501":"The server does not support the functionality required to fulfill the request.","502":"The server, while acting as a gateway or proxy, received an invalid response from the upstream server.","503":"The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.","504":"The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server.","505":"The server does not support, or refuses to support, the major version of HTTP that was used in the request message.","506":"The server has an internal configuration error where the chosen variant resource is configured to engage in transparent content negotiation itself.","507":"The method could not be performed on the resource because the server is unable to store the representation needed to complete the request.","508":"The server terminated an operation because it encountered an infinite loop while processing a conditional request.","510":"Further extensions to the request are required for the server to fulfill it.","511":"The client needs to authenticate to gain network access before sending requests."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesHttpStatusCodeEnum"}]},"errorMessage":{"type":"string","uniqueItems":false},"date":{"type":"string","uniqueItems":false}},"required":["webhookId","httpStatusCode","date"]}},"components/schemas/BundlesBundlesRegionEnum":{"id":"components/schemas/BundlesBundlesRegionEnum","kind":"json-schema","title":"BundlesBundlesRegionEnum","data":{"type":"string","enum":["BR","EU","US"],"description":"Region resources were create in."}},"components/schemas/BundlesSubprojectStatusEnum":{"id":"components/schemas/BundlesSubprojectStatusEnum","kind":"json-schema","title":"BundlesSubprojectStatusEnum","data":{"type":"string","enum":["PENDING","READY"],"description":"Status of subproject."}},"components/schemas/BundlesSubprojectDto":{"id":"components/schemas/BundlesSubprojectDto","kind":"json-schema","title":"BundlesSubprojectDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Subproject id.","uniqueItems":false},"name":{"type":"string","description":"Name of Subproject.","maxLength":255,"uniqueItems":false},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Project labels, if provided.","uniqueItems":false},"parentProjectId":{"type":"string","description":"Parent project id which the subproject is associated with.","uniqueItems":false},"status":{"x-enumDescriptions":{"PENDING":"The secondary asset profile deployment awaits structural orchestration steps.","READY":"The secondary asset profile configuration is entirely compiled and active."},"description":"Status of subproject.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesSubprojectStatusEnum"}]}},"required":["id","name","parentProjectId","status"]}},"components/schemas/BundlesProvisioningStatesEnum":{"id":"components/schemas/BundlesProvisioningStatesEnum","kind":"json-schema","title":"BundlesProvisioningStatesEnum","data":{"type":"string","enum":["ACTIVE","BLOCKED","DELETED","DEPROVISIONING","DEPROVISIONING_FAILED","FAILED_ADD","FAILED_BLOCK","FAILED_DELETE","FAILED_UNBLOCK","FAILED_UPDATE","IN_PROGRESS_ADD","IN_PROGRESS_BLOCK","IN_PROGRESS_DELETE","IN_PROGRESS_UNBLOCK","IN_PROGRESS_UPDATE","PENDING_ADD","PENDING_BLOCK","PENDING_DELETE","PENDING_UNBLOCK","PENDING_UPDATE","PROVISIONING","PROVISIONING_ADD","PROVISIONING_ADD_FAILED","PROVISIONING_BLOCK","PROVISIONING_BLOCK_FAILED","PROVISIONING_FAILED","PROVISIONING_UNBLOCK","PROVISIONING_UNBLOCK_FAILED","PROVISIONING_UPDATE","PROVISIONING_UPDATE_FAILED","STATUS_UNSPECIFIED","UNRECOGNIZED"],"description":"Status of SMS App."}},"components/schemas/BundlesSmsAppRegionsEnum":{"id":"components/schemas/BundlesSmsAppRegionsEnum","kind":"json-schema","title":"BundlesSmsAppRegionsEnum","data":{"type":"string","enum":["AU","BR","CA","EU","US","UNRECOGNIZED"],"description":"List of regions of the app."}},"components/schemas/BundlesBundlesSmsAppDto":{"id":"components/schemas/BundlesBundlesSmsAppDto","kind":"json-schema","title":"BundlesBundlesSmsAppDto","data":{"type":"object","properties":{"id":{"type":"string","description":"SMS App id.","uniqueItems":false},"smsServiceId":{"type":"string","description":"Id of the SMS Service which the SMS App belongs to.","uniqueItems":false},"name":{"type":"string","description":"Name of SMS App.","uniqueItems":false},"status":{"x-enumDescriptions":{"ACTIVE":"The resource is active and ready to use.","BLOCKED":"The resource is blocked and cannot be used.","DELETED":"The resource has been deleted.","DEPROVISIONING":"The resource deprovisioning is currently in progress.","DEPROVISIONING_FAILED":"The resource deprovisioning failed and requires attention.","FAILED_ADD":"Adding the resource failed during the provisioning sequence.","FAILED_BLOCK":"Blocking the resource failed during the provisioning sequence.","FAILED_DELETE":"Deleting the resource failed during the provisioning sequence.","FAILED_UNBLOCK":"Unblocking the resource failed during the provisioning sequence.","FAILED_UPDATE":"Updating the resource failed during the provisioning sequence.","IN_PROGRESS_ADD":"The resource creation sequence is currently in progress.","IN_PROGRESS_BLOCK":"The resource blocking sequence is currently in progress.","IN_PROGRESS_DELETE":"The resource deletion sequence is currently in progress.","IN_PROGRESS_UNBLOCK":"The resource unblocking sequence is currently in progress.","IN_PROGRESS_UPDATE":"The resource update sequence is currently in progress.","PENDING_ADD":"The resource creation sequence is queued and waiting to start.","PENDING_BLOCK":"The resource blocking sequence is queued and waiting to start.","PENDING_DELETE":"The resource deletion sequence is queued and waiting to start.","PENDING_UNBLOCK":"The resource unblocking sequence is queued and waiting to start.","PENDING_UPDATE":"The resource update sequence is queued and waiting to start.","PROVISIONING":"The provisioning sequence is currently in progress.","PROVISIONING_ADD":"The provisioning system is actively processing resource creation.","PROVISIONING_ADD_FAILED":"The provisioning flow failed while attempting to create the resource.","PROVISIONING_BLOCK":"The provisioning system is actively processing resource blocking.","PROVISIONING_BLOCK_FAILED":"The provisioning flow failed while attempting to block the resource.","PROVISIONING_FAILED":"The provisioning sequence failed and requires technical attention.","PROVISIONING_UNBLOCK":"The provisioning system is actively processing resource unblocking.","PROVISIONING_UNBLOCK_FAILED":"The provisioning flow failed while attempting to unblock the resource.","PROVISIONING_UPDATE":"The provisioning system is actively processing a resource update.","PROVISIONING_UPDATE_FAILED":"The provisioning flow failed while attempting to update the resource.","STATUS_UNSPECIFIED":"The provisioning status was not specified by the upstream system.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Status of SMS App.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesProvisioningStatesEnum"}]},"regions":{"type":"array","x-enumDescriptions":{"AU":"The application operates within the Australia region.","BR":"The application operates within the Brazil region.","CA":"The application operates within the Canada region.","EU":"The application operates within the Europe region.","US":"The application operates within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"List of regions of the app.","uniqueItems":false,"items":{"$ref":"#/components/schemas/BundlesSmsAppRegionsEnum"}},"test":{"type":"boolean","description":"True if the app is a test app.","uniqueItems":false},"numberVerified":{"type":"boolean","description":"Indicates whether the phone number associated with the SMS app has been verified.","uniqueItems":false}},"required":["id","smsServiceId","name","status","regions","test","numberVerified"]}},"components/schemas/BundlesWebhooksWebhookTriggerEnum":{"id":"components/schemas/BundlesWebhooksWebhookTriggerEnum","kind":"json-schema","title":"BundlesWebhooksWebhookTriggerEnum","data":{"type":"string","enum":["BATCH_DELIVERY_REPORT_FULL","BATCH_DELIVERY_REPORT_SUMMARY","BATCH_STATUS_UPDATE","BILLING_CREDIT_LIMIT_BREACHED","CAPABILITY","CHANNEL_EVENT","CONSENT_BATCH_COMPLETE","CONTACT_CREATE","CONTACT_DELETE","CONTACT_IDENTITIES_DUPLICATION","CONTACT_MERGE","CONTACT_UPDATE","CONVERSATION_DELETE","CONVERSATION_START","CONVERSATION_STOP","EVENT_DELIVERY","EVENT_INBOUND","MESSAGE_DELIVERY","MESSAGE_INBOUND","MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION","MESSAGE_SUBMIT","OPT_IN","OPT_OUT","RECORD_NOTIFICATION","SMART_CONVERSATION","UNRECOGNIZED","UNSPECIFIED_TRIGGER","UNSUPPORTED"],"description":"An array of triggers that should trigger the webhook and result in an event being sent to the target url."}},"components/schemas/BundlesConversationAppWebhooksDto":{"id":"components/schemas/BundlesConversationAppWebhooksDto","kind":"json-schema","title":"BundlesConversationAppWebhooksDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the webhook.","uniqueItems":false},"target":{"type":"string","maxLength":742,"description":"The target url where events should be sent to.","uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BATCH_DELIVERY_REPORT_FULL":"The event payload signifies a complete batch delivery report execution loop.","BATCH_DELIVERY_REPORT_SUMMARY":"The event payload signifies a condensed data summary of a batch delivery footprint.","BATCH_STATUS_UPDATE":"The event payload signifies a progressive operational change in an active message batch.","BILLING_CREDIT_LIMIT_BREACHED":"The event payload signifies that account messaging balances have exceeded soft credit caps.","CAPABILITY":"The event payload signifies an explicit update to the underlying destination parameters.","CHANNEL_EVENT":"The event payload signifies a native interaction anomaly or change on the network tier.","CONSENT_BATCH_COMPLETE":"The event payload signifies that group user permissions have finished compiling.","CONTACT_CREATE":"The event payload signifies that a fresh contact record has entered active storage.","CONTACT_DELETE":"The event payload signifies the explicit extraction of a contact record from system indexes.","CONTACT_IDENTITIES_DUPLICATION":"The event payload signifies that matching unique pointers exist within parallel client rows.","CONTACT_MERGE":"The event payload signifies that redundant system identity fragments consolidated.","CONTACT_UPDATE":"The event payload signifies modified operational information inside an existing profile block.","CONVERSATION_DELETE":"The event payload signifies that a session context data footprint has been purged.","CONVERSATION_START":"The event payload signifies that a synchronous messaging session context has successfully spun up.","CONVERSATION_STOP":"The event payload signifies that a session interaction path has timed out or finished.","EVENT_DELIVERY":"The event payload signifies the confirmed routing of a channel context event.","EVENT_INBOUND":"The event payload signifies an incoming channel context packet arriving from an exterior service.","MESSAGE_DELIVERY":"The event payload signifies a confirmed successful transit milestone to the recipient endpoint.","MESSAGE_INBOUND":"The event payload signifies an active user response or message arrival at the gateway layer.","MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION":"The event payload signifies a user message that has been automatically modified to strip sensitive parameters.","MESSAGE_SUBMIT":"The event payload signifies that an outbound message request has completed original system ingestion.","OPT_IN":"The event payload signifies a distinct user action authorizing outbound communications.","OPT_OUT":"The event payload signifies an explicit customer action withdrawing notification authorization.","RECORD_NOTIFICATION":"The event payload signifies an audit or event observation milestone update.","SMART_CONVERSATION":"The event payload signifies the evaluation phase completion of an intelligent agent workflow.","UNSPECIFIED_TRIGGER":"The event payload lacks explicit category properties or contains a legacy definition structure.","UNSUPPORTED":"The event payload matches a recognized platform definition but remains unconfigured on this service.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"maxItems":20,"uniqueItems":true,"description":"An array of triggers that should trigger the webhook and result in an event being sent to the target url.","items":{"$ref":"#/components/schemas/BundlesWebhooksWebhookTriggerEnum"}},"secret":{"type":"string","description":"Optional secret used to sign contents of webhooks sent by the Conversation API. You can then use the secret to verify the signature.","uniqueItems":false}},"required":["id","target","triggers"]}},"components/schemas/BundlesConversationAppProcessingModesEnum":{"id":"components/schemas/BundlesConversationAppProcessingModesEnum","kind":"json-schema","title":"BundlesConversationAppProcessingModesEnum","data":{"type":"string","enum":["CONVERSATION","DISPATCH","UNRECOGNIZED","UNSPECIFIED"],"description":"Conversation API processing mode."}},"components/schemas/BundlesConversationAppRetentionPolicyTypesEnum":{"id":"components/schemas/BundlesConversationAppRetentionPolicyTypesEnum","kind":"json-schema","title":"BundlesConversationAppRetentionPolicyTypesEnum","data":{"type":"string","enum":["CONVERSATION_EXPIRE_POLICY","MESSAGE_EXPIRE_POLICY","PERSIST_RETENTION_POLICY","UNRECOGNIZED"],"description":"\nConversation API retention policy type.\n    "}},"components/schemas/BundlesConversationAppRetentionPolicyDto":{"id":"components/schemas/BundlesConversationAppRetentionPolicyDto","kind":"json-schema","title":"BundlesConversationAppRetentionPolicyDto","data":{"type":"object","properties":{"retentionPolicyType":{"x-enumDescriptions":{"CONVERSATION_EXPIRE_POLICY":"The entire conversation expires after the configured retention period.","MESSAGE_EXPIRE_POLICY":"Individual messages expire after the configured retention period.","PERSIST_RETENTION_POLICY":"The conversation data is retained indefinitely until it is explicitly removed.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"\nConversation API retention policy type.\n    ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppRetentionPolicyTypesEnum"}]},"ttl":{"type":"number","description":"\nConversation API retention time in days.\n    ","uniqueItems":false}},"required":["retentionPolicyType"]}},"components/schemas/BundlesConversationAppConsentManagerSettingsModesEnum":{"id":"components/schemas/BundlesConversationAppConsentManagerSettingsModesEnum","kind":"json-schema","title":"BundlesConversationAppConsentManagerSettingsModesEnum","data":{"type":"string","enum":["DISABLED","PRIMARY","SECONDARY","UNRECOGNIZED"],"description":"\nConversation API consent manager settings mode.\n    "}},"components/schemas/BundlesConversationAppConsentManagerSettingsDto":{"id":"components/schemas/BundlesConversationAppConsentManagerSettingsDto","kind":"json-schema","title":"BundlesConversationAppConsentManagerSettingsDto","data":{"type":"object","properties":{"mode":{"x-enumDescriptions":{"DISABLED":"The consent manager integration is disabled.","PRIMARY":"The consent manager utilizes the primary data governance tracking mode.","SECONDARY":"The consent manager utilizes the secondary data governance fallback tracking mode.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"\nConversation API consent manager settings mode.\n    ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppConsentManagerSettingsModesEnum"}]}},"required":["mode"]}},"components/schemas/BundlesConversationAppChannelIntegrationStatusEnum":{"id":"components/schemas/BundlesConversationAppChannelIntegrationStatusEnum","kind":"json-schema","title":"BundlesConversationAppChannelIntegrationStatusEnum","data":{"type":"string","enum":["ACTIVE","FAILING","PENDING","UNRECOGNIZED"],"description":"Status of the SMS channel credentials integration."}},"components/schemas/BundlesConversationAppDto":{"id":"components/schemas/BundlesConversationAppDto","kind":"json-schema","title":"BundlesConversationAppDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Conversation App id.","uniqueItems":false},"name":{"type":"string","description":"Name of Conversation App.","maxLength":255,"uniqueItems":false},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/BundlesConversationAppWebhooksDto"},"maxItems":5,"description":"List all webhooks for a given app.","uniqueItems":false},"processingMode":{"x-enumDescriptions":{"CONVERSATION":"Messages are processed using conversational logic, maintaining context and state.","DISPATCH":"Messages are processed using fire-and-forget dispatch logic without active state management.","UNSPECIFIED":"The message processing mode is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Conversation API processing mode.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppProcessingModesEnum"}]},"retentionPolicy":{"description":"Conversation API retention policy for messages and conversations.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppRetentionPolicyDto"}]},"consentManagerSettings":{"description":"Conversation API consent manager settings.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppConsentManagerSettingsDto"}]},"smsChannelStatus":{"x-enumDescriptions":{"ACTIVE":"The channel integration is active and operating as expected.","FAILING":"The channel integration is failing and requires manual troubleshooting.","PENDING":"The channel integration setup or synchronization is pending completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Status of the SMS channel credentials integration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppChannelIntegrationStatusEnum"}]}},"required":["id","name","processingMode"]}},"components/schemas/BundlesWebhookDto":{"id":"components/schemas/BundlesWebhookDto","kind":"json-schema","title":"BundlesWebhookDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the webhook.","uniqueItems":false},"target":{"type":"string","description":"The target url where events will be sent to.","uniqueItems":false},"projectId":{"type":"string","description":"The project that this webhook belongs to.","uniqueItems":false},"triggers":{"type":"array","x-enumDescriptions":{"BUNDLE_DONE":"Webhook event triggered when a bundle processing flow is completed.","RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED":"Webhook event triggered when the RCS brand registration process status changes.","RCS_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS sender.","RCS_SENDER_OPERATOR_STATUS_UPDATED":"Webhook event triggered when an RCS sender operator status changes.","RCS_SENDER_STATUS_UPDATED":"Webhook event triggered when an RCS sender status changes.","RCS_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to an RCS account.","KAKAOTALK_SENDER_ACTIVE":"Webhook event triggered when a KakaoTalk sender becomes active.","KAKAOTALK_SENDER_INACTIVE":"Webhook event triggered when a KakaoTalk sender becomes inactive.","KAKAOTALK_SENDER_REJECTED":"Webhook event triggered when a KakaoTalk sender is rejected.","KAKAOTALK_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk sender.","KAKAOTALK_TEMPLATE_APPROVED":"Webhook event triggered when a KakaoTalk template is approved.","KAKAOTALK_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a KakaoTalk template.","KAKAOTALK_TEMPLATE_REJECTED":"Webhook event triggered when a KakaoTalk template is rejected.","WHATSAPP_ACCOUNT_ONBOARDED":"Webhook event triggered when a WhatsApp account onboarding is completed.","WHATSAPP_ACCOUNT_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp account is pending verification.","WHATSAPP_ACCOUNT_REJECTED":"Webhook event triggered when a WhatsApp account is rejected.","WHATSAPP_ACCOUNT_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp account.","WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp account daily messaging limit changes.","WHATSAPP_WABA_ACCOUNT_CHANGED":"Webhook event triggered when the linked WhatsApp Business Account changes.","WHATSAPP_SENDER_ACTIVE":"Webhook event triggered when a WhatsApp sender becomes active.","WHATSAPP_SENDER_INACTIVE":"Webhook event triggered when a WhatsApp sender becomes inactive.","WHATSAPP_SENDER_REJECTED":"Webhook event triggered when a WhatsApp sender is rejected.","WHATSAPP_SENDER_DELETED":"Webhook event triggered when a WhatsApp sender is deleted.","WHATSAPP_SENDER_DISPLAY_NAME_UPDATED":"Webhook event triggered when a WhatsApp sender display name is updated.","WHATSAPP_SENDER_ERROR":"Webhook event triggered when a WhatsApp sender enters an error state.","WHATSAPP_SENDER_PENDING_VERIFICATION":"Webhook event triggered when a WhatsApp sender is pending verification.","WHATSAPP_SENDER_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp sender.","WHATSAPP_SENDER_DAILY_LIMIT_CHANGED":"Webhook event triggered when a WhatsApp sender daily messaging limit changes.","WHATSAPP_SENDER_QUALITY_RATING_CHANGED":"Webhook event triggered when a WhatsApp sender quality rating changes.","WHATSAPP_SENDER_USERNAME_UPDATED":"Webhook event triggered when a WhatsApp sender username is updated.","WHATSAPP_TEMPLATE_APPROVED":"Webhook event triggered when a WhatsApp template is approved.","WHATSAPP_TEMPLATE_REJECTED":"Webhook event triggered when a WhatsApp template is rejected.","WHATSAPP_TEMPLATE_DELETED":"Webhook event triggered when a WhatsApp template is deleted.","WHATSAPP_TEMPLATE_COMMENT_ADDED":"Webhook event triggered when a new comment is added to a WhatsApp template.","WHATSAPP_TEMPLATE_STATUS_UPDATED":"Webhook event triggered when a WhatsApp template status changes.","WHATSAPP_TEMPLATE_CATEGORY_UPDATED":"Webhook event triggered when a WhatsApp template category changes.","WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE":"Webhook event triggered when a future WhatsApp template category update is scheduled.","WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED":"Webhook event triggered when a WhatsApp template quality score changes.","ALL":"Webhook event triggered for all supported events."},"uniqueItems":true,"description":"List of triggers this webhook is triggered by.","items":{"$ref":"#/components/schemas/BundlesWebhookTriggersEnum"}}},"required":["id","target","projectId","triggers"]}},"components/schemas/BundlesBundlesDto":{"id":"components/schemas/BundlesBundlesDto","kind":"json-schema","title":"BundlesBundlesDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of bundle created.","uniqueItems":false},"projectId":{"type":"string","description":"The project or subproject id where resources have been created.","uniqueItems":false},"name":{"type":"string","description":"Name of bundle created. If a name was not specified in the resource blocks then they were created with this name.","maxLength":255,"uniqueItems":false},"state":{"x-enumDescriptions":{"DONE":"The service setup has completed successfully.","FAILED":"The service setup failed and requires troubleshooting or manual retry.","IN_PROGRESS":"The service setup is currently executing."},"description":"Current state.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesBundleServicesStateEnum"}]},"webhookDeliveryStatuses":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List delivery statuses for all BUNDLE_DONE webhooks."},"children":[]}]}]}],"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/BundlesWebhookDeliveryStatusDto"}},"region":{"x-enumDescriptions":{"BR":"The resources are provisioned and active within the Brazil region.","EU":"The resources are provisioned and active within the Europe region.","US":"The resources are provisioned and active within the United States region."},"description":"Region resources were create in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesBundlesRegionEnum"}]},"subproject":{"description":"Subproject created, if requested.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesSubprojectDto"}]},"smsApp":{"description":"SMS App created, if requested.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesBundlesSmsAppDto"}]},"convApp":{"description":"Conversation App created, if requested.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/BundlesConversationAppDto"}]},"webhooks":{"description":"Webhooks registered, if requested.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/BundlesWebhookDto"}}},"required":["id","projectId","state","region"]}},"components/schemas/BundlesPapiErrorDto":{"id":"components/schemas/BundlesPapiErrorDto","kind":"json-schema","title":"BundlesPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/BundlesListBundlesDto":{"id":"components/schemas/BundlesListBundlesDto","kind":"json-schema","title":"BundlesListBundlesDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"bundles":{"description":"List of bundles.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/BundlesBundlesDto"}}},"required":["totalSize","pageSize","bundles"]}},"components/schemas/KakaotalkSenderCategoryDto":{"id":"components/schemas/KakaotalkSenderCategoryDto","kind":"json-schema","title":"KakaotalkSenderCategoryDto","data":{"type":"object","properties":{"parentCode":{"type":"string","minLength":0,"maxLength":4,"description":"The code of the parent category.","uniqueItems":false},"depth":{"type":"number","maximum":3,"minimum":1,"description":"The depth in category tree.","uniqueItems":false},"code":{"type":"string","minLength":3,"maxLength":4,"description":"The code of the category.","uniqueItems":false},"name":{"type":"string","description":"The name of the category.","uniqueItems":false},"subcategories":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderCategoryDto"},"description":"List of subcategories.","uniqueItems":false}},"required":["parentCode","depth","code","name","subcategories"]}},"components/schemas/KakaotalkSenderCategoryListDto":{"id":"components/schemas/KakaotalkSenderCategoryListDto","kind":"json-schema","title":"KakaotalkSenderCategoryListDto","data":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderCategoryDto"},"description":"List of sender categories.","uniqueItems":false}},"required":["categories"]}},"components/schemas/KakaotalkPapiErrorDto":{"id":"components/schemas/KakaotalkPapiErrorDto","kind":"json-schema","title":"KakaotalkPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/KakaotalkTemplateSubcategoryNamesEnum":{"id":"components/schemas/KakaotalkTemplateSubcategoryNamesEnum","kind":"json-schema","title":"KakaotalkTemplateSubcategoryNamesEnum","data":{"type":"string","enum":["인증/비밀번호/로그인","회원가입","회원정보/회원혜택","구매예약/입고알림","구매완료","구매취소","상품가입","진행상태","예약상태","예약알림/리마인드","예약완료/예약내역","예약취소","구매감사/이용확인","리마인드","방문서비스","신청접수","이용도구","이용안내/공지","처리완료","피드백 요청","거래알림","계약/견적","뉴스레터","안전/피해예방","요금청구","피드백","배송상태","배송실패","배송예정","배송완료","개인정보","수신동의","약관변경","휴면 관련","내부 업무 알림","주문/예약","쿠폰/포인트안내","쿠폰발급","쿠폰사용","포인트사용","포인트적립","기타","UNRECOGNIZED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"하위 카테고리 이름."},"children":[]}]}]}]}},"components/schemas/KakaotalkTemplateSubcategoryEnglishNamesEnum":{"id":"components/schemas/KakaotalkTemplateSubcategoryEnglishNamesEnum","kind":"json-schema","title":"KakaotalkTemplateSubcategoryEnglishNamesEnum","data":{"type":"string","enum":["Authentication/Password/Login","Join membership","Membership information/Member ship benefits","Pre-order/Stock alerts","Product subscription","Purchase cancellation","Purchase completed","Purchase status","Completed reservations/Reservation history","Notification/Reminder","Reservation cancellation","Reservation status","Application reception","Feedback request","Greeting message/Order confirmation","Information/Notification","Notification for treated demands","Reminder message","Tools for use","Visiting service","Billing","Contract/Quote","Feedback","Newsletter","Safety/Damage prevention","Transaction notification","Failed shipment","Shipping completed","Shipping estimation","Shipping status","Change of terms and conditions","Consent of reception","Dormant account related","Privacy","Internal business notification","Order/Reservation","Coupon issuance","Earn points","Information coupon/Points","Notification for coupon use","Use of points","Others","UNRECOGNIZED"],"description":"English subcategory name."}},"components/schemas/KakaotalkTemplateSubcategoryDto":{"id":"components/schemas/KakaotalkTemplateSubcategoryDto","kind":"json-schema","title":"KakaotalkTemplateSubcategoryDto","data":{"type":"object","properties":{"code":{"type":"string","description":"Subcategory code (Used when registering/modifying templates).","uniqueItems":false},"name":{"x-enumDescriptions":{"인증/비밀번호/로그인":"Indicates the content handles user authentication, password resets, or secure login procedures.","회원가입":"Indicates the content manages new user onboarding and loyalty program registrations.","회원정보/회원혜택":"Indicates the content details account metadata, tier statuses, or specific membership benefits.","구매예약/입고알림":"Indicates the content triggers pre-order confirmations or product inventory stock alerts.","구매완료":"Indicates the content serves as a final transactional confirmation for completed purchases.","구매취소":"Indicates the content documents the formal cancellation and reversal of a purchase transaction.","상품가입":"Indicates the content processes recurrent product subscriptions and service lifecycle updates.","진행상태":"Indicates the content tracks progressive changes in an active order lifecycle status.","예약상태":"Indicates the content monitors progressive changes in an active booking or reservation lifecycle.","예약알림/리마인드":"Indicates the content provides generic operational notifications or structural system reminders.","예약완료/예약내역":"Indicates the content provides historical verification blocks for completed reservations.","예약취소":"Indicates the content verifies the formal cancellation of a scheduled booking.","구매감사/이용확인":"Indicates the content acts as an initialization welcome message or initial order ingestion receipt.","리마인드":"Indicates the content acts as a time-bound reminder message for an upcoming event or deadline.","방문서비스":"Indicates the content manages logistics and scheduling windows for physical on-site or visiting services.","신청접수":"Indicates the content acknowledges the successful receipt and ingestion of a formal application form.","이용도구":"Indicates the content contains operational instructions, utility metrics, or guides for specific software tools.","이용안내/공지":"Indicates the content delivers standard informational notifications or transactional bulletins.","처리완료":"Indicates the content signals that a previously submitted support ticket or user demand has been resolved.","피드백 요청":"Indicates the content initiates a post-interaction feedback request or satisfaction survey.","거래알림":"Indicates the content delivers standard accounting ledger notifications and financial transaction footprints.","계약/견적":"Indicates the content transmits formal contracts, legal terms, or pricing quote documents.","뉴스레터":"Indicates the content distributes regular updates, information articles, or community newsletters.","안전/피해예방":"Indicates the content provides emergency safety notices, product recalls, or hazard damage prevention alerts.","요금청구":"Indicates the content delivers invoice notifications, payment statements, or billing ledger logs.","피드백":"Indicates the content processes user evaluation notes, product reviews, or generic feedback.","배송상태":"Indicates the content tracks real-time progress updates for package shipping milestones.","배송실패":"Indicates the content flags cargo shipping anomalies, courier failures, or missed delivery attempts.","배송예정":"Indicates the content calculates scheduled delivery timelines and shipping estimation windows.","배송완료":"Indicates the content verifies that a package or cargo asset has been successfully delivered.","개인정보":"Indicates the content handles user data governance disclosures or privacy compliance changes.","수신동의":"Indicates the content logs opt-in choices or formal data consent updates for inbound communication paths.","약관변경":"Indicates the content details critical modifications to the application terms, service agreements, or conditions.","휴면 관련":"Indicates the content manages alerts for inactive profiles or impending dormant account purges.","내부 업무 알림":"Indicates the content routes internal operational notifications targeted at team personnel or system nodes.","주문/예약":"Indicates the content relates to generic purchase orders or structured service reservation flows.","쿠폰/포인트안내":"Indicates the content summarizes generic information regarding customer coupons or loyalty point balances.","쿠폰발급":"Indicates the content acts as an automated delivery event for newly issued discount coupons.","쿠폰사용":"Indicates the content triggers immediate event logs confirming the execution and use of a coupon.","포인트사용":"Indicates the content documents an account balance debit event following the redemption of points.","포인트적립":"Indicates the content documents an account balance credit event following the accumulation of loyalty points.","기타":"Indicates the content belongs to subcategories that fall outside the standard defined taxonomy.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"하위 카테고리 이름."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateSubcategoryNamesEnum"}]},"nameEnglish":{"x-enumDescriptions":{"Authentication/Password/Login":"The English linguistic localization identifier for authentication, password resets, or secure login workflows.","Join membership":"The English linguistic localization identifier for new user onboarding and account registrations.","Membership information/Member ship benefits":"The English linguistic localization identifier for membership account metadata, tier statuses, and program benefits.","Pre-order/Stock alerts":"The English linguistic localization identifier for pre-order updates and inventory stock level alerts.","Product subscription":"The English linguistic localization identifier for recurrent product subscriptions and service lifecycle events.","Purchase cancellation":"The English linguistic localization identifier for the formal cancellation and reversal of a purchase transaction.","Purchase completed":"The English linguistic localization identifier for final transactional confirmations of completed purchases.","Purchase status":"The English linguistic localization identifier for tracking progressive state changes within an active order lifecycle.","Completed reservations/Reservation history":"The English linguistic localization identifier for historical log entries of completed reservations.","Notification/Reminder":"The English linguistic localization identifier for generic operational notifications or system-wide reminders.","Reservation cancellation":"The English linguistic localization identifier for confirming the formal cancellation of a scheduled booking.","Reservation status":"The English linguistic localization identifier for monitoring progressive lifecycle updates of an active reservation.","Application reception":"The English linguistic localization identifier for acknowledging the successful receipt and ingestion of an application.","Feedback request":"The English linguistic localization identifier for initiating post-interaction customer feedback requests or surveys.","Greeting message/Order confirmation":"The English linguistic localization identifier for welcoming customers or confirming original order ingestion receipts.","Information/Notification":"The English linguistic localization identifier for standard transactional notifications and informational bulletins.","Notification for treated demands":"The English linguistic localization identifier for signaling that a previously submitted support ticket or user demand has been resolved.","Reminder message":"The English linguistic localization identifier for time-bound reminders regarding upcoming events or action items.","Tools for use":"The English linguistic localization identifier for operational instruction guides, user metrics, or specific software utilities.","Visiting service":"The English linguistic localization identifier for logistics, scheduling windows, and updates for on-site services.","Billing":"The English linguistic localization identifier for invoice notifications, payment statements, and billing ledger logs.","Contract/Quote":"The English linguistic localization identifier for transmitting formal contracts, legal terms, or pricing quote documents.","Feedback":"The English linguistic localization identifier for processing customer evaluation notes, product reviews, or general comments.","Newsletter":"The English linguistic localization identifier for distributing periodic updates, informational articles, or community news.","Safety/Damage prevention":"The English linguistic localization identifier for urgent safety announcements, product recalls, or hazard mitigation alerts.","Transaction notification":"The English linguistic localization identifier for standard accounting logs and financial transaction updates.","Failed shipment":"The English linguistic localization identifier for reporting cargo transit anomalies, courier exceptions, or missed delivery attempts.","Shipping completed":"The English linguistic localization identifier for verifying that a package or cargo asset has been successfully delivered.","Shipping estimation":"The English linguistic localization identifier for calculated transit timelines and estimated delivery date windows.","Shipping status":"The English linguistic localization identifier for tracking real-time status milestones of an active package shipment.","Change of terms and conditions":"The English linguistic localization identifier for documenting critical modifications to application terms or service agreements.","Consent of reception":"The English linguistic localization identifier for logging opt-in updates and data consent changes for inbound communication channels.","Dormant account related":"The English linguistic localization identifier for automated warning logs regarding inactive profiles or impending account purges.","Privacy":"The English linguistic localization identifier for user data privacy governance updates and compliance disclosures.","Internal business notification":"The English linguistic localization identifier for routing internal operational notifications to team personnel or system nodes.","Order/Reservation":"The English linguistic localization identifier for tracking generic purchase orders or structured service reservation flows.","Coupon issuance":"The English linguistic localization identifier for automated delivery events of newly issued discount coupons.","Earn points":"The English linguistic localization identifier for credit event logs recording the accumulation of loyalty points.","Information coupon/Points":"The English linguistic localization identifier for reporting general balance information regarding coupons or loyalty points.","Notification for coupon use":"The English linguistic localization identifier for immediate transaction confirmations verifying a coupon redemption.","Use of points":"The English linguistic localization identifier for account debit logs recording the redemption of loyalty points.","Others":"The English linguistic localization identifier for templates categorized outside the standard platform taxonomy.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"English subcategory name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateSubcategoryEnglishNamesEnum"}]},"groupName":{"type":"string","description":"Subcategory group name.","uniqueItems":false},"inclusion":{"type":"string","description":"Description of templates to which the subcategory applies.","uniqueItems":false},"exclusion":{"type":"string","description":"Description of templates to which the subcategory does not apply.","uniqueItems":false}},"required":["code","name","nameEnglish","groupName","inclusion","exclusion"]}},"components/schemas/KakaotalkTemplateCategoryNamesEnum":{"id":"components/schemas/KakaotalkTemplateCategoryNamesEnum","kind":"json-schema","title":"KakaotalkTemplateCategoryNamesEnum","data":{"type":"string","enum":["구매","기타","리포팅","배송","법적고지","서비스이용","업무알림","예약","쿠폰/포인트","회원","UNRECOGNIZED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"카테고리 이름."},"children":[]}]}]}]}},"components/schemas/KakaotalkTemplateCategoryEnglishNamesEnum":{"id":"components/schemas/KakaotalkTemplateCategoryEnglishNamesEnum","kind":"json-schema","title":"KakaotalkTemplateCategoryEnglishNamesEnum","data":{"type":"string","enum":["Business notification","Coupon/Points","Customer service","Legal notification","Membership","Others","Purchase","Reports","Reservation","Shipping","UNRECOGNIZED"],"description":"English category name."}},"components/schemas/KakaotalkTemplateCategoryDto":{"id":"components/schemas/KakaotalkTemplateCategoryDto","kind":"json-schema","title":"KakaotalkTemplateCategoryDto","data":{"type":"object","properties":{"name":{"x-enumDescriptions":{"구매":"Indicates the content is reserved for transactional purchase confirmations and receipts.","기타":"Indicates the content belongs to templates that do not align with any standard category.","리포팅":"Indicates the content provides system reports, statements, and summary updates.","배송":"Indicates the content covers logistics, shipping tracking, and delivery progress.","법적고지":"Indicates the content handles regulatory, legal, or compliance-related notifications.","서비스이용":"Indicates the content focuses on customer support, assistance, and service workflows.","업무알림":"Indicates the content carries operational business notifications and transactional notices.","예약":"Indicates the content handles booking confirmations and reservation-related logs.","쿠폰/포인트":"Indicates the content distributes coupons, loyalty points, or similar promotional balance rewards.","회원":"Indicates the content manages user accounts, loyalty registrations, and membership updates.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"카테고리 이름."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateCategoryNamesEnum"}]},"nameEnglish":{"x-enumDescriptions":{"Business notification":"The English linguistic localization identifier for operational business notifications.","Coupon/Points":"The English linguistic localization identifier for coupons, points, and promotional balance rewards.","Customer service":"The English linguistic localization identifier for customer support and service workflows.","Legal notification":"The English linguistic localization identifier for regulatory or compliance-related notices.","Membership":"The English linguistic localization identifier for member accounts and loyalty programs.","Others":"The English linguistic localization identifier for templates falling outside standard groups.","Purchase":"The English linguistic localization identifier for transactional purchase statements.","Reports":"The English linguistic localization identifier for analytical report definitions and summaries.","Reservation":"The English linguistic localization identifier for booking actions and reservation entries.","Shipping":"The English linguistic localization identifier for cargo routing and parcel delivery updates.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"English category name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateCategoryEnglishNamesEnum"}]},"subcategories":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateSubcategoryDto"},"description":"List of subcategories.","uniqueItems":false}},"required":["name","nameEnglish","subcategories"]}},"components/schemas/KakaotalkTemplateCategoryListDto":{"id":"components/schemas/KakaotalkTemplateCategoryListDto","kind":"json-schema","title":"KakaotalkTemplateCategoryListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"categories":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateCategoryDto"},"description":"List of template categories.","uniqueItems":false}},"required":["totalSize","pageSize","categories"]}},"components/schemas/KakaotalkTemplateStatesEnum":{"id":"components/schemas/KakaotalkTemplateStatesEnum","kind":"json-schema","title":"KakaotalkTemplateStatesEnum","data":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The current state of the template."}},"components/schemas/KakaotalkKakaoTalkButtonTypeEnum":{"id":"components/schemas/KakaotalkKakaoTalkButtonTypeEnum","kind":"json-schema","title":"KakaotalkKakaoTalkButtonTypeEnum","data":{"type":"string","enum":["APP_LINK","BOT_FOR_CONSULTATION","BOT_KEYWORD","BOT_TRANSFER","BUSINESS_FORM","BUTTON_TYPE_UNSPECIFIED","CHANNEL_ID_ADDED","DELIVERY_SEARCH","IMAGE_SECURE_TRANSMISSION_PLUGIN_ID","MESSAGE_DELIVERY","ONE_CLICK_PAYMENT_PLUGIN","PERSONAL_INFORMATION_USE_PLUGIN_ID","WEB_LINK","UNRECOGNIZED"],"description":"Button type"}},"components/schemas/KakaotalkButtonDto":{"id":"components/schemas/KakaotalkButtonDto","kind":"json-schema","title":"KakaotalkButtonDto","data":{"type":"object","properties":{"ordering":{"type":"number","description":"Button sequence","uniqueItems":false},"type":{"x-enumDescriptions":{"APP_LINK":"Launches a deep link to open a specific target within a mobile application.","BOT_FOR_CONSULTATION":"Initializes an interactive support or automated consultation flow with a chat bot.","BOT_KEYWORD":"Submits a predefined automated keyword response block back to the chat bot.","BOT_TRANSFER":"Transfers the current communication context directly into a bot interaction sequence.","BUSINESS_FORM":"Launches an embedded native Kakao business questionnaire or lead collection form.","BUTTON_TYPE_UNSPECIFIED":"The configuration properties for the button type are unspecified.","CHANNEL_ID_ADDED":"Triggers a native prompt encouraging the end-user to subscribe to or add the Kakao channel.","DELIVERY_SEARCH":"Redirects the user to external delivery tracking metrics or shipping cargo lookups.","IMAGE_SECURE_TRANSMISSION_PLUGIN_ID":"Launches a secure verification plugin context dedicated to image file transmission.","MESSAGE_DELIVERY":"Advances the template execution loop to continue the underlying message delivery flow.","ONE_CLICK_PAYMENT_PLUGIN":"Launches an integrated native plug-in interface to complete a one-click payment checkout.","PERSONAL_INFORMATION_USE_PLUGIN_ID":"Launches a secure personal data governance plugin to gather explicit user privacy consent.","WEB_LINK":"Launches a target external URL routing path inside a web browser environment.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Button type","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkButtonTypeEnum"}]},"name":{"type":"string","description":"Button name","uniqueItems":false},"linkMo":{"type":"string","format":"url","description":"Mobile web link","uniqueItems":false},"linkPc":{"type":"string","format":"url","description":"PC web link","uniqueItems":false},"schemeIos":{"type":"string","description":"iOS app link","uniqueItems":false},"schemeAndroid":{"type":"string","description":"Android app link","uniqueItems":false}}}},"components/schemas/KakaotalkTemplateLanguagesEnum":{"id":"components/schemas/KakaotalkTemplateLanguagesEnum","kind":"json-schema","title":"KakaotalkTemplateLanguagesEnum","data":{"type":"string","enum":["AF","AR","AZ","BG","BN","CA","CS","DA","DE","EL","EN","EN_GB","EN_US","ES","ES_AR","ES_ES","ES_MX","ET","FA","FI","FIL","FR","GA","GU","HA","HE","HI","HR","HU","ID","IT","JA","KA","KK","KN","KO","KY_KG","LO","LT","LV","MK","ML","MR","MS","NB","NL","PA","PL","PT_BR","PT_PT","RO","RU","RW_RW","SK","SL","SQ","SR","SV","SW","TA","TE","TH","TR","UK","UR","UZ","VI","ZH_CN","ZH_HK","ZH_TW","ZU","UNRECOGNIZED"],"description":"Template language"}},"components/schemas/KakaotalkKakaoTalkTemplateMessageTypeEnum":{"id":"components/schemas/KakaotalkKakaoTalkTemplateMessageTypeEnum","kind":"json-schema","title":"KakaotalkKakaoTalkTemplateMessageTypeEnum","data":{"type":"string","enum":["AD_INCLUDED","BASIC","EXTRA_INFORMATION","MIXED","TEMPLATE_MESSAGE_TYPE_UNSPECIFIED","UNRECOGNIZED"],"description":"Types of template message"}},"components/schemas/KakaotalkKakaoTalkTemplateEmphasizeTypeEnum":{"id":"components/schemas/KakaotalkKakaoTalkTemplateEmphasizeTypeEnum","kind":"json-schema","title":"KakaotalkKakaoTalkTemplateEmphasizeTypeEnum","data":{"type":"string","enum":["EMPHASIZE_TYPE_IMAGE","EMPHASIZE_TYPE_NONE","EMPHASIZE_TYPE_TEXT","EMPHASIZE_TYPE_UNSPECIFIED","UNRECOGNIZED"],"description":"Types of emphasized template"}},"components/schemas/KakaotalkTemplateDetailsDto":{"id":"components/schemas/KakaotalkTemplateDetailsDto","kind":"json-schema","title":"KakaotalkTemplateDetailsDto","data":{"type":"object","properties":{"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateLanguagesEnum"}]},"messageType":{"x-enumDescriptions":{"AD_INCLUDED":"The layout includes explicit promotional or advertising blocks.","BASIC":"The standard layout without supplementary structural elements.","EXTRA_INFORMATION":"The layout features an appended metadata or supplementary info block.","MIXED":"The layout consolidates multiple structural interaction fields.","TEMPLATE_MESSAGE_TYPE_UNSPECIFIED":"The layout structure is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateMessageTypeEnum"}]},"emphasizeType":{"x-enumDescriptions":{"EMPHASIZE_TYPE_IMAGE":"Applies structural highlighting focused primarily on an image element.","EMPHASIZE_TYPE_NONE":"No additional structural or visual highlighting is applied.","EMPHASIZE_TYPE_TEXT":"Applies structural highlighting focused on high-visibility text copy.","EMPHASIZE_TYPE_UNSPECIFIED":"The layout highlighting type is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateEmphasizeTypeEnum"}]},"categoryCode":{"type":"string","description":"Template category code","uniqueItems":false},"securityFlag":{"type":"boolean","description":"Security template","uniqueItems":false},"name":{"type":"string","description":"Button name","uniqueItems":false},"content":{"type":"string","description":"Template body","uniqueItems":false},"extra":{"type":"string","description":"Additional template information","uniqueItems":false},"ad":{"type":"string","description":"Request for consent of receiving within template or simple ad phrases","uniqueItems":false},"title":{"type":"string","description":"Template title","uniqueItems":false},"subtitle":{"type":"string","description":"Auxiliary template phrase","uniqueItems":false},"imageName":{"type":"string","description":"Image name (name of uploaded file)","uniqueItems":false},"imageUrl":{"type":"string","format":"url","description":"Image URL","uniqueItems":false},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkButtonDto"},"description":"List of buttons","uniqueItems":false}},"required":["language","messageType","emphasizeType","categoryCode","securityFlag","name","buttons"]}},"components/schemas/KakaotalkTemplateChangesDetailsDto":{"id":"components/schemas/KakaotalkTemplateChangesDetailsDto","kind":"json-schema","title":"KakaotalkTemplateChangesDetailsDto","data":{"type":"object","properties":{"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateLanguagesEnum"}]},"messageType":{"x-enumDescriptions":{"AD_INCLUDED":"The layout includes explicit promotional or advertising blocks.","BASIC":"The standard layout without supplementary structural elements.","EXTRA_INFORMATION":"The layout features an appended metadata or supplementary info block.","MIXED":"The layout consolidates multiple structural interaction fields.","TEMPLATE_MESSAGE_TYPE_UNSPECIFIED":"The layout structure is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateMessageTypeEnum"}]},"emphasizeType":{"x-enumDescriptions":{"EMPHASIZE_TYPE_IMAGE":"Applies structural highlighting focused primarily on an image element.","EMPHASIZE_TYPE_NONE":"No additional structural or visual highlighting is applied.","EMPHASIZE_TYPE_TEXT":"Applies structural highlighting focused on high-visibility text copy.","EMPHASIZE_TYPE_UNSPECIFIED":"The layout highlighting type is unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkKakaoTalkTemplateEmphasizeTypeEnum"}]},"categoryCode":{"type":"string","description":"Template category code","uniqueItems":false},"securityFlag":{"type":"boolean","description":"Security template","uniqueItems":false},"name":{"type":"string","description":"Button name","uniqueItems":false},"content":{"type":"string","description":"Template body","uniqueItems":false},"extra":{"type":"string","description":"Additional template information","uniqueItems":false},"ad":{"type":"string","description":"Request for consent of receiving within template or simple ad phrases","uniqueItems":false},"title":{"type":"string","description":"Template title","uniqueItems":false},"subtitle":{"type":"string","description":"Auxiliary template phrase","uniqueItems":false},"imageName":{"type":"string","description":"Image name (name of uploaded file)","uniqueItems":false},"imageUrl":{"type":"string","format":"url","description":"Image URL","uniqueItems":false},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkButtonDto"},"description":"List of buttons","uniqueItems":false}}}},"components/schemas/KakaotalkTemplateStatusesEnum":{"id":"components/schemas/KakaotalkTemplateStatusesEnum","kind":"json-schema","title":"KakaotalkTemplateStatusesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","REJECTED"],"description":"Current status of the pending changes"}},"components/schemas/KakaotalkTemplateChangesDto":{"id":"components/schemas/KakaotalkTemplateChangesDto","kind":"json-schema","title":"KakaotalkTemplateChangesDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"The template changes are saved as a draft only.","IN_PROGRESS":"The template changes have been submitted and are still processing.","REJECTED":"The template changes have been reviewed and rejected."},"description":"Current status of the pending changes","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateStatusesEnum"}]},"details":{"oneOf":[{"$ref":"#/components/schemas/KakaotalkTemplateDetailsDto","description":"For newly created template"},{"$ref":"#/components/schemas/KakaotalkTemplateChangesDetailsDto","description":"For update template"}],"description":"Template details and information.","uniqueItems":false}},"required":["status","details"]}},"components/schemas/KakaotalkTemplateDto":{"id":"components/schemas/KakaotalkTemplateDto","kind":"json-schema","title":"KakaotalkTemplateDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the template.","uniqueItems":false},"code":{"type":"string","description":"Registered delivery template code","uniqueItems":false},"state":{"x-enumDescriptions":{"APPROVED":"The template is approved and available for use.","REJECTED":"The template was rejected and cannot be used."},"description":"The current state of the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateStatesEnum"}]},"changes":{"description":"Any pending changes to the template.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateChangesDto"}]},"details":{"description":"Template details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateDetailsDto"}]},"created":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the template was created.","uniqueItems":false},"modified":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the template was last modified.","uniqueItems":false}},"required":["code"]}},"components/schemas/KakaotalkTemplateListDto":{"id":"components/schemas/KakaotalkTemplateListDto","kind":"json-schema","title":"KakaotalkTemplateListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"templates":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateDto"},"description":"List of templates","uniqueItems":false}},"required":["totalSize","pageSize","templates"]}},"components/schemas/KakaotalkActionsEnum":{"id":"components/schemas/KakaotalkActionsEnum","kind":"json-schema","title":"KakaotalkActionsEnum","data":{"type":"string","enum":["DRAFT","SUBMIT"],"description":"Create as draft or submit. Defaults to submit."}},"components/schemas/KakaotalkInputKakaoTalkButtonTypeEnum":{"id":"components/schemas/KakaotalkInputKakaoTalkButtonTypeEnum","kind":"json-schema","title":"KakaotalkInputKakaoTalkButtonTypeEnum","data":{"type":"string","enum":["APP_LINK","BOT_FOR_CONSULTATION","BOT_KEYWORD","BOT_TRANSFER","BUSINESS_FORM","CHANNEL_ID_ADDED","DELIVERY_SEARCH","IMAGE_SECURE_TRANSMISSION_PLUGIN_ID","MESSAGE_DELIVERY","ONE_CLICK_PAYMENT_PLUGIN","PERSONAL_INFORMATION_USE_PLUGIN_ID","WEB_LINK"],"description":"Button type"}},"components/schemas/KakaotalkInputButtonDto":{"id":"components/schemas/KakaotalkInputButtonDto","kind":"json-schema","title":"KakaotalkInputButtonDto","data":{"type":"object","properties":{"ordering":{"type":"number","minimum":1,"maximum":5,"description":"Button sequence","uniqueItems":false},"type":{"x-enumDescriptions":{"APP_LINK":"Launches a deep link to open a specific target within a mobile application.","BOT_FOR_CONSULTATION":"Initializes an interactive support or automated consultation flow with a chat bot.","BOT_KEYWORD":"Submits a predefined automated keyword response block back to the chat bot.","BOT_TRANSFER":"Transfers the current communication context directly into a bot interaction sequence.","BUSINESS_FORM":"Launches an embedded native Kakao business questionnaire or lead collection form.","CHANNEL_ID_ADDED":"Triggers a native prompt encouraging the end-user to subscribe to or add the Kakao channel.","DELIVERY_SEARCH":"Redirects the user to external delivery tracking metrics or shipping cargo lookups.","IMAGE_SECURE_TRANSMISSION_PLUGIN_ID":"Launches a secure verification plugin context dedicated to image file transmission.","MESSAGE_DELIVERY":"Advances the template execution loop to continue the underlying message delivery flow.","ONE_CLICK_PAYMENT_PLUGIN":"Launches an integrated native plug-in interface to complete a one-click payment checkout.","PERSONAL_INFORMATION_USE_PLUGIN_ID":"Launches a secure personal data governance plugin to gather explicit user privacy consent.","WEB_LINK":"Launches a target external URL routing path inside a web browser environment."},"description":"Button type","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkButtonTypeEnum"}]},"name":{"type":"string","minLength":1,"maxLength":14,"description":"Button name Not required for draft.","uniqueItems":false},"linkMo":{"type":"string","format":"url","minLength":1,"maxLength":500,"description":"Mobile web link","uniqueItems":false},"linkPc":{"type":"string","format":"url","minLength":1,"maxLength":500,"description":"PC web link","uniqueItems":false},"schemeIos":{"type":"string","format":"url","minLength":1,"maxLength":500,"description":"iOS app link","uniqueItems":false},"schemeAndroid":{"type":"string","format":"url","minLength":1,"maxLength":500,"description":"Android app link","uniqueItems":false}},"required":["ordering","type","name"]}},"components/schemas/KakaotalkInputTemplateLanguagesEnum":{"id":"components/schemas/KakaotalkInputTemplateLanguagesEnum","kind":"json-schema","title":"KakaotalkInputTemplateLanguagesEnum","data":{"type":"string","enum":["AF","AR","AZ","BG","BN","CA","CS","DA","DE","EL","EN","EN_GB","EN_US","ES","ES_AR","ES_ES","ES_MX","ET","FA","FI","FIL","FR","GA","GU","HA","HE","HI","HR","HU","ID","IT","JA","KA","KK","KN","KO","KY_KG","LO","LT","LV","MK","ML","MR","MS","NB","NL","PA","PL","PT_BR","PT_PT","RO","RU","RW_RW","SK","SL","SQ","SR","SV","SW","TA","TE","TH","TR","UK","UR","UZ","VI","ZH_CN","ZH_HK","ZH_TW","ZU"],"description":"Template language"}},"components/schemas/KakaotalkInputKakaoTalkTemplateMessageTypeEnum":{"id":"components/schemas/KakaotalkInputKakaoTalkTemplateMessageTypeEnum","kind":"json-schema","title":"KakaotalkInputKakaoTalkTemplateMessageTypeEnum","data":{"type":"string","enum":["AD_INCLUDED","BASIC","EXTRA_INFORMATION","MIXED"],"description":"Types of template message"}},"components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeTypeEnum":{"id":"components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeTypeEnum","kind":"json-schema","title":"KakaotalkInputKakaoTalkTemplateEmphasizeTypeEnum","data":{"type":"string","enum":["EMPHASIZE_TYPE_IMAGE","EMPHASIZE_TYPE_NONE","EMPHASIZE_TYPE_TEXT"],"description":"Types of emphasized template"}},"components/schemas/KakaotalkInputTemplateDetailsDto":{"id":"components/schemas/KakaotalkInputTemplateDetailsDto","kind":"json-schema","title":"KakaotalkInputTemplateDetailsDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":"Button name","uniqueItems":false},"language":{"x-enumDescriptions":{"AF":"The language configuration is set to Afrikaans.","AR":"The language configuration is set to Arabic.","AZ":"The language configuration is set to Azerbaijani.","BG":"The language configuration is set to Bulgarian.","BN":"The language configuration is set to Bengali.","CA":"The language configuration is set to Catalan.","CS":"The language configuration is set to Czech.","DA":"The language configuration is set to Danish.","DE":"The language configuration is set to German.","EL":"The language configuration is set to Greek.","EN":"The language configuration is set to English.","EN_GB":"The language configuration is set to British English.","EN_US":"The language configuration is set to American English.","ES":"The language configuration is set to Spanish.","ES_AR":"The language configuration is set to Argentinian Spanish.","ES_ES":"The language configuration is set to European Spanish.","ES_MX":"The language configuration is set to Mexican Spanish.","ET":"The language configuration is set to Estonian.","FA":"The language configuration is set to Persian.","FI":"The language configuration is set to Finnish.","FIL":"The language configuration is set to Filipino.","FR":"The language configuration is set to French.","GA":"The language configuration is set to Irish.","GU":"The language configuration is set to Gujarati.","HA":"The language configuration is set to Hausa.","HE":"The language configuration is set to Hebrew.","HI":"The language configuration is set to Hindi.","HR":"The language configuration is set to Croatian.","HU":"The language configuration is set to Hungarian.","ID":"The language configuration is set to Indonesian.","IT":"The language configuration is set to Italian.","JA":"The language configuration is set to Japanese.","KA":"The language configuration is set to Georgian.","KK":"The language configuration is set to Kazakh.","KN":"The language configuration is set to Kannada.","KO":"The language configuration is set to Korean.","KY_KG":"The language configuration is set to Kyrgyz.","LO":"The language configuration is set to Lao.","LT":"The language configuration is set to Lithuanian.","LV":"The language configuration is set to Latvian.","MK":"The language configuration is set to Macedonian.","ML":"The language configuration is set to Malayalam.","MR":"The language configuration is set to Marathi.","MS":"The language configuration is set to Malay.","NB":"The language configuration is set to Norwegian.","NL":"The language configuration is set to Dutch.","PA":"The language configuration is set to Punjabi.","PL":"The language configuration is set to Polish.","PT_BR":"The language configuration is set to Brazilian Portuguese.","PT_PT":"The language configuration is set to European Portuguese.","RO":"The language configuration is set to Romanian.","RU":"The language configuration is set to Russian.","RW_RW":"The language configuration is set to Kinyarwanda.","SK":"The language configuration is set to Slovak.","SL":"The language configuration is set to Slovenian.","SQ":"The language configuration is set to Albanian.","SR":"The language configuration is set to Serbian.","SV":"The language configuration is set to Swedish.","SW":"The language configuration is set to Swahili.","TA":"The language configuration is set to Tamil.","TE":"The language configuration is set to Telugu.","TH":"The language configuration is set to Thai.","TR":"The language configuration is set to Turkish.","UK":"The language configuration is set to Ukrainian.","UR":"The language configuration is set to Urdu.","UZ":"The language configuration is set to Uzbek.","VI":"The language configuration is set to Vietnamese.","ZH_CN":"The language configuration is set to Simplified Chinese.","ZH_HK":"The language configuration is set to Traditional Chinese (Hong Kong).","ZH_TW":"The language configuration is set to Traditional Chinese (Taiwan).","ZU":"The language configuration is set to Zulu."},"description":"Template language","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputTemplateLanguagesEnum"}]},"content":{"type":"string","minLength":1,"maxLength":1000,"description":"Template body Not required for draft.","uniqueItems":false},"messageType":{"x-enumDescriptions":{"AD_INCLUDED":"The layout includes explicit promotional or advertising blocks.","BASIC":"The standard layout without supplementary structural elements.","EXTRA_INFORMATION":"The layout features an appended metadata or supplementary info block.","MIXED":"The layout consolidates multiple structural interaction fields."},"default":"BASIC","description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateMessageTypeEnum"}]},"emphasizeType":{"x-enumDescriptions":{"EMPHASIZE_TYPE_IMAGE":"Applies structural highlighting focused primarily on an image element.","EMPHASIZE_TYPE_NONE":"No additional structural or visual highlighting is applied.","EMPHASIZE_TYPE_TEXT":"Applies structural highlighting focused on high-visibility text copy."},"default":"EMPHASIZE_TYPE_NONE","description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeTypeEnum"}]},"categoryCode":{"type":"string","minLength":1,"maxLength":6,"default":"999999","description":"Template category code","uniqueItems":false},"securityFlag":{"type":"boolean","default":false,"description":"Security template\n  Set for security messages such as OTP\n  If set, message text is unexposed to all devices except for the main device at the time of sending","uniqueItems":false},"extra":{"type":"string","minLength":1,"maxLength":500,"description":"Additional template information","uniqueItems":false},"title":{"type":"string","minLength":1,"maxLength":50,"description":"Template Title (No more than 50 characters,\n    Android: To be abbreviated if it exceeds 2 lines with more than 23 characters,\n    iOS: To be abbreviated if it exceeds 2 lines with more than 27 characters)","uniqueItems":false},"subtitle":{"type":"string","minLength":1,"maxLength":50,"description":"Auxiliary Template Phrase (No more than 50 characters,\n    Android: To be abbreviated if it exceeds 18 characters,\n    iOS: To be abbreviated if it exceeds 21 characters)","uniqueItems":false},"imageName":{"type":"string","minLength":1,"maxLength":250,"description":"Image name (name of uploaded file)","uniqueItems":false},"imageUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 500KB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 500 x 250 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aspect ratio: 2 x 1."},"children":[]}]}]}]}],"uniqueItems":false},"buttons":{"uniqueItems":true,"minItems":0,"maxItems":5,"description":"List of buttons Field 'type' must have unique values across items.","type":"array","items":{"$ref":"#/components/schemas/KakaotalkInputButtonDto"}}},"required":["name","language","content"]}},"components/schemas/KakaotalkInputTemplateDto":{"id":"components/schemas/KakaotalkInputTemplateDto","kind":"json-schema","title":"KakaotalkInputTemplateDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"default":"SUBMIT","description":"Create as draft or submit. Defaults to submit.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActionsEnum"}]},"details":{"description":"Template details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputTemplateDetailsDto"}]},"saveDraftOnFailure":{"type":"boolean","default":false,"description":"Flag to save template as draft if submission fails. Defaults to false.","uniqueItems":false}},"required":["details"]}},"components/schemas/KakaotalkInputUpdateTemplateDetailsDto":{"id":"components/schemas/KakaotalkInputUpdateTemplateDetailsDto","kind":"json-schema","title":"KakaotalkInputUpdateTemplateDetailsDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":"Button name","uniqueItems":false},"content":{"type":"string","minLength":1,"maxLength":1000,"description":"Template body","uniqueItems":false},"messageType":{"x-enumDescriptions":{"AD_INCLUDED":"The layout includes explicit promotional or advertising blocks.","BASIC":"The standard layout without supplementary structural elements.","EXTRA_INFORMATION":"The layout features an appended metadata or supplementary info block.","MIXED":"The layout consolidates multiple structural interaction fields."},"description":"Types of template message","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateMessageTypeEnum"}]},"emphasizeType":{"x-enumDescriptions":{"EMPHASIZE_TYPE_IMAGE":"Applies structural highlighting focused primarily on an image element.","EMPHASIZE_TYPE_NONE":"No additional structural or visual highlighting is applied.","EMPHASIZE_TYPE_TEXT":"Applies structural highlighting focused on high-visibility text copy."},"description":"Types of emphasized template","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputKakaoTalkTemplateEmphasizeTypeEnum"}]},"categoryCode":{"type":"string","minLength":1,"maxLength":6,"description":"Template category code","uniqueItems":false},"securityFlag":{"type":"boolean","description":"Security template\n  Set for security messages such as OTP\n  If set, message text is unexposed to all devices except for the main device at the time of sending","uniqueItems":false},"extra":{"minLength":1,"maxLength":500,"description":"Additional template information","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"title":{"minLength":1,"maxLength":50,"description":"Template Title (No more than 50 characters,\n    Android: To be abbreviated if it exceeds 2 lines with more than 23 characters,\n    iOS: To be abbreviated if it exceeds 2 lines with more than 27 characters)","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"subtitle":{"minLength":1,"maxLength":50,"description":"Auxiliary Template Phrase (No more than 50 characters,\n    Android: To be abbreviated if it exceeds 18 characters,\n    iOS: To be abbreviated if it exceeds 21 characters)","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"imageName":{"minLength":1,"maxLength":250,"description":"Image name (name of uploaded file)","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"imageUrl":{"format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 500KB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum image dimensions: 500 x 250 px."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aspect ratio: 2 x 1."},"children":[]}]}]}]}],"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"buttons":{"uniqueItems":true,"minItems":0,"maxItems":5,"description":"List of buttons Field 'type' must have unique values across items.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkInputButtonDto"}},{"type":"null"}]}}}},"components/schemas/KakaotalkInputUpdateTemplateDto":{"id":"components/schemas/KakaotalkInputUpdateTemplateDto","kind":"json-schema","title":"KakaotalkInputUpdateTemplateDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActionsEnum"}]},"details":{"description":"Template details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputUpdateTemplateDetailsDto"}]}}}},"components/schemas/KakaotalkCommentTypeEnum":{"id":"components/schemas/KakaotalkCommentTypeEnum","kind":"json-schema","title":"KakaotalkCommentTypeEnum","data":{"type":"string","const":"CREATED"}},"components/schemas/KakaotalkCommentDto":{"id":"components/schemas/KakaotalkCommentDto","kind":"json-schema","title":"KakaotalkCommentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"CREATED":"Indicates the comment has been successfully created and published."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkCommentTypeEnum"}]},"comment":{"type":"string","uniqueItems":false},"created":{"type":"string","uniqueItems":false}},"required":["type","comment"]}},"components/schemas/KakaotalkCommentInputDto":{"id":"components/schemas/KakaotalkCommentInputDto","kind":"json-schema","title":"KakaotalkCommentInputDto","data":{"type":"object","properties":{"comment":{"type":"string","minLength":1,"maxLength":65535,"uniqueItems":false}},"required":["comment"]}},"components/schemas/KakaotalkTemplateNotificationTypeEnum":{"id":"components/schemas/KakaotalkTemplateNotificationTypeEnum","kind":"json-schema","title":"KakaotalkTemplateNotificationTypeEnum","data":{"type":"string","enum":["COMMENT_ADDED","CREATED","DRAFT","EDITED","IN_PROGRESS","REJECTED"]}},"components/schemas/KakaotalkTemplateNotificationDto":{"id":"components/schemas/KakaotalkTemplateNotificationDto","kind":"json-schema","title":"KakaotalkTemplateNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created.","DRAFT":"The notification configuration is currently in a draft state.","EDITED":"The notification configuration has been edited or updated.","IN_PROGRESS":"The notification process is currently executing.","REJECTED":"The notification configuration has been rejected."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/KakaotalkTemplateNotificationListDto":{"id":"components/schemas/KakaotalkTemplateNotificationListDto","kind":"json-schema","title":"KakaotalkTemplateNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/KakaotalkSenderStatesEnum":{"id":"components/schemas/KakaotalkSenderStatesEnum","kind":"json-schema","title":"KakaotalkSenderStatesEnum","data":{"type":"string","enum":["ACTIVE","BLOCKED","INACTIVE","SUSPENDED","VERIFYING"],"description":"The current state of the sender."}},"components/schemas/KakaotalkSenderDetailsDto":{"id":"components/schemas/KakaotalkSenderDetailsDto","kind":"json-schema","title":"KakaotalkSenderDetailsDto","data":{"type":"object","properties":{"adminPhoneNo":{"type":"string","description":"Admin phone","uniqueItems":false},"name":{"type":"string","description":"Sender name","uniqueItems":false},"logoImage":{"type":"string","description":"Sender logo","uniqueItems":false},"topLevelCategoryCode":{"type":"string","description":"Top level category code, must consist of 3 digits (e.g. 001).","uniqueItems":false},"midLevelCategoryCode":{"type":"string","description":"Mid level category code, must consist of 4 digits (e.g. 0001).","uniqueItems":false},"subLevelCategoryCode":{"type":"string","description":"Sub level category code, must consist of 4 digits (e.g. 0001).","uniqueItems":false}},"required":["adminPhoneNo","name","topLevelCategoryCode","midLevelCategoryCode","subLevelCategoryCode"]}},"components/schemas/KakaotalkSenderChangesDetailsDto":{"id":"components/schemas/KakaotalkSenderChangesDetailsDto","kind":"json-schema","title":"KakaotalkSenderChangesDetailsDto","data":{"type":"object","properties":{"adminPhoneNo":{"type":"string","description":"Admin phone","uniqueItems":false},"name":{"type":"string","description":"Sender name","uniqueItems":false},"logoImage":{"type":"string","description":"Sender logo","uniqueItems":false},"topLevelCategoryCode":{"type":"string","description":"Top level category code, must consist of 3 digits (e.g. 001).","uniqueItems":false},"midLevelCategoryCode":{"type":"string","description":"Mid level category code, must consist of 4 digits (e.g. 0001).","uniqueItems":false},"subLevelCategoryCode":{"type":"string","description":"Sub level category code, must consist of 4 digits (e.g. 0001).","uniqueItems":false}}}},"components/schemas/KakaotalkSenderStatusesEnum":{"id":"components/schemas/KakaotalkSenderStatusesEnum","kind":"json-schema","title":"KakaotalkSenderStatusesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","REJECTED"],"description":"Current status of the pending changes."}},"components/schemas/KakaotalkSenderChangesDto":{"id":"components/schemas/KakaotalkSenderChangesDto","kind":"json-schema","title":"KakaotalkSenderChangesDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"The modifications to the sender identity are saved as a draft only.","IN_PROGRESS":"The modifications to the sender identity have been submitted and are still processing.","REJECTED":"The modifications to the sender identity have been reviewed and rejected."},"description":"Current status of the pending changes.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderStatusesEnum"}]},"details":{"oneOf":[{"$ref":"#/components/schemas/KakaotalkSenderDetailsDto","description":"For newly created sender"},{"$ref":"#/components/schemas/KakaotalkSenderChangesDetailsDto","description":"For update sender"}],"description":"Sender details and information.","uniqueItems":false}},"required":["status","details"]}},"components/schemas/KakaotalkSenderDto":{"id":"components/schemas/KakaotalkSenderDto","kind":"json-schema","title":"KakaotalkSenderDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sender.","uniqueItems":false},"plusFriendId":{"type":"string","description":"PlusFriend ID","uniqueItems":false},"state":{"x-enumDescriptions":{"ACTIVE":"The sender identity is active and ready to dispatch messages.","BLOCKED":"The sender identity is blocked and cannot be used for any operations.","INACTIVE":"The sender identity exists within the system but is currently not active.","SUSPENDED":"The sender identity has been temporarily suspended due to administrative or policy reasons.","VERIFYING":"The sender identity is currently undergoing the compliance and verification process."},"description":"The current state of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderStatesEnum"}]},"changes":{"description":"Any pending changes to the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderChangesDto"}]},"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderDetailsDto"}]},"created":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was created.","uniqueItems":false},"modified":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was last modified.","uniqueItems":false}},"required":["plusFriendId"]}},"components/schemas/KakaotalkInputSenderDetailsDto":{"id":"components/schemas/KakaotalkInputSenderDetailsDto","kind":"json-schema","title":"KakaotalkInputSenderDetailsDto","data":{"type":"object","properties":{"adminPhoneNo":{"type":"string","minLength":1,"maxLength":15,"description":"Admin phone  Not required for draft.","format":"phone number","uniqueItems":false},"name":{"type":"string","minLength":1,"maxLength":512,"description":"Sender name Not required for draft.","uniqueItems":false},"logoImage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender logo"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 5MB."},"children":[]}]}]}]}],"format":"url","uniqueItems":false},"topLevelCategoryCode":{"type":"string","description":"Top level category code, must consist of 3 digits (e.g. 001). Not required for draft.","uniqueItems":false},"midLevelCategoryCode":{"type":"string","description":"Mid level category code, must consist of 4 digits (e.g. 0001). Not required for draft.","uniqueItems":false},"subLevelCategoryCode":{"type":"string","description":"Sub level category code, must consist of 4 digits (e.g. 0001). Not required for draft.","uniqueItems":false}},"required":["adminPhoneNo","name","topLevelCategoryCode","midLevelCategoryCode","subLevelCategoryCode"]}},"components/schemas/KakaotalkInputSenderDto":{"id":"components/schemas/KakaotalkInputSenderDto","kind":"json-schema","title":"KakaotalkInputSenderDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"description":"Create as draft or submit. Defaults to submit.","default":"SUBMIT","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActionsEnum"}]},"saveDraftOnFailure":{"type":"boolean","default":false,"description":"Flag to save template as draft if submission fails. Defaults to false.","uniqueItems":false},"plusFriendId":{"type":"string","description":"PlusFriend ID","minLength":1,"maxLength":30,"uniqueItems":false},"details":{"description":"Sender details and information. Not required for draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputSenderDetailsDto"}]}},"required":["plusFriendId","details"]}},"components/schemas/KakaotalkInputVerifySenderDto":{"id":"components/schemas/KakaotalkInputVerifySenderDto","kind":"json-schema","title":"KakaotalkInputVerifySenderDto","data":{"type":"object","properties":{"code":{"type":"number","examples":[123456],"description":"Numeric code to verify the sender.","uniqueItems":false}},"required":["code"]}},"components/schemas/KakaotalkSenderListDto":{"id":"components/schemas/KakaotalkSenderListDto","kind":"json-schema","title":"KakaotalkSenderListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"senders":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderDto"},"description":"List of senders.","uniqueItems":false}},"required":["totalSize","pageSize","senders"]}},"components/schemas/KakaotalkSenderNotificationTypeEnum":{"id":"components/schemas/KakaotalkSenderNotificationTypeEnum","kind":"json-schema","title":"KakaotalkSenderNotificationTypeEnum","data":{"type":"string","enum":["ACTIVE","COMMENT_ADDED","CREATED","DRAFT","EDITED","IN_PROGRESS","INACTIVE","REJECTED"]}},"components/schemas/KakaotalkSenderNotificationDto":{"id":"components/schemas/KakaotalkSenderNotificationDto","kind":"json-schema","title":"KakaotalkSenderNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"ACTIVE":"The notification configuration is active and enabled.","COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created.","DRAFT":"The notification configuration is currently in a draft state.","EDITED":"The notification configuration has been edited or updated.","INACTIVE":"The notification configuration is inactive or disabled.","IN_PROGRESS":"The notification process is currently executing.","REJECTED":"The notification configuration has been rejected."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkSenderNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/KakaotalkSenderNotificationListDto":{"id":"components/schemas/KakaotalkSenderNotificationListDto","kind":"json-schema","title":"KakaotalkSenderNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/KakaotalkInputUpdateSenderDetailsDto":{"id":"components/schemas/KakaotalkInputUpdateSenderDetailsDto","kind":"json-schema","title":"KakaotalkInputUpdateSenderDetailsDto","data":{"type":"object","properties":{"adminPhoneNo":{"type":"string","minLength":1,"maxLength":15,"description":"Admin phone","format":"phone number","uniqueItems":false},"name":{"type":"string","minLength":1,"maxLength":512,"description":"Sender name","uniqueItems":false},"logoImage":{"description":"Sender logo","format":"url","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"topLevelCategoryCode":{"type":"string","description":"Top level category code, must consist of 3 digits (e.g. 001).","uniqueItems":false},"midLevelCategoryCode":{"type":"string","description":"Mid level category code, must consist of 4 digits (e.g. 0001).","uniqueItems":false},"subLevelCategoryCode":{"type":"string","description":"Sub level category code, must consist of 4 digits (e.g. 0001).","uniqueItems":false}}}},"components/schemas/KakaotalkInputUpdateSenderDto":{"id":"components/schemas/KakaotalkInputUpdateSenderDto","kind":"json-schema","title":"KakaotalkInputUpdateSenderDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"DRAFT":"Saves the pending changes as a draft without submitting them to the system.","SUBMIT":"Submits the pending changes directly for processing."},"default":"DRAFT","description":"Create as draft or submit. Defaults to draft.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkActionsEnum"}]},"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/KakaotalkInputUpdateSenderDetailsDto"}]}}}},"components/schemas/ConversationChannelStatusEnum":{"id":"components/schemas/ConversationChannelStatusEnum","kind":"json-schema","title":"ConversationChannelStatusEnum","data":{"type":"string","enum":["ACTIVE","ERROR","FAILING","PENDING","UNRECOGNIZED"],"description":"Channel integration status."}},"components/schemas/ConversationTelegramBotInfoDto":{"id":"components/schemas/ConversationTelegramBotInfoDto","kind":"json-schema","title":"ConversationTelegramBotInfoDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"ACTIVE":"The communication channel is active and operating normally.","ERROR":"The communication channel has encountered an operational error and is disabled.","FAILING":"The communication channel is failing validation or delivery metrics and requires troubleshooting.","PENDING":"The communication channel setup or verification is pending system completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatusEnum"}]},"statusDescription":{"type":"string","description":"Channel integration description if status is ERROR or FAILED.","uniqueItems":false},"name":{"type":"string","description":"Name of the bot.","uniqueItems":false},"username":{"type":"string","description":"Username of the bot.","uniqueItems":false},"canJoinGroups":{"type":"boolean","description":"If the bot can be invited to groups.","uniqueItems":false},"canReadAllGroupMessages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://core.telegram.org/bots#privacy-mode"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"privacy mode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disabled for the bot."},"children":[]}]}]}],"uniqueItems":false},"supportsInlineQueries":{"type":"boolean","description":"If the bot supports inline queries.","uniqueItems":false}},"required":["status"]}},"components/schemas/ConversationPapiErrorDto":{"id":"components/schemas/ConversationPapiErrorDto","kind":"json-schema","title":"ConversationPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/ConversationAccountLocationDto":{"id":"components/schemas/ConversationAccountLocationDto","kind":"json-schema","title":"ConversationAccountLocationDto","data":{"type":"object","properties":{"lon":{"type":"number","description":"Location longitude","uniqueItems":false},"lat":{"type":"number","description":"Location latitude","uniqueItems":false}},"required":["lon","lat"]}},"components/schemas/ConversationViberBotInfoDto":{"id":"components/schemas/ConversationViberBotInfoDto","kind":"json-schema","title":"ConversationViberBotInfoDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"ACTIVE":"The communication channel is active and operating normally.","ERROR":"The communication channel has encountered an operational error and is disabled.","FAILING":"The communication channel is failing validation or delivery metrics and requires troubleshooting.","PENDING":"The communication channel setup or verification is pending system completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatusEnum"}]},"statusDescription":{"type":"string","description":"Channel integration description if status is ERROR or FAILED.","uniqueItems":false},"id":{"type":"string","description":"Account ID","uniqueItems":false},"name":{"type":"string","description":"Account name","uniqueItems":false},"uri":{"type":"string","description":"Account URI","uniqueItems":false},"icon":{"type":"string","description":"Account icon URI","uniqueItems":false},"category":{"type":"string","description":"Account category","uniqueItems":false},"subcategory":{"type":"string","description":"Account subcategory","uniqueItems":false},"location":{"description":"Account location","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationAccountLocationDto"}]},"country":{"type":"string","description":"Account country name (long)","uniqueItems":false},"subscribersCount":{"type":"number","description":"Account subscribers count","uniqueItems":false}},"required":["status"]}},"components/schemas/ConversationInstagramInfoDto":{"id":"components/schemas/ConversationInstagramInfoDto","kind":"json-schema","title":"ConversationInstagramInfoDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"ACTIVE":"The communication channel is active and operating normally.","ERROR":"The communication channel has encountered an operational error and is disabled.","FAILING":"The communication channel is failing validation or delivery metrics and requires troubleshooting.","PENDING":"The communication channel setup or verification is pending system completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatusEnum"}]},"statusDescription":{"type":"string","description":"Channel integration description if status is ERROR or FAILED.","uniqueItems":false},"id":{"type":"string","description":"Instagram ID.","uniqueItems":false},"name":{"type":"string","description":"Public profile name if set.","uniqueItems":false},"username":{"type":"string","description":"Profile username.","uniqueItems":false},"biography":{"type":"string","description":"Public profile biography if set.","uniqueItems":false},"followersCount":{"type":"number","description":"Total number of Instagram users following the sender.","uniqueItems":false},"followsCount":{"type":"number","description":"Total number of Instagram users the sender follows.","uniqueItems":false},"mediaCount":{"type":"number","description":"Total number of Instagram Media published on the sender.","uniqueItems":false},"profilePictureUrl":{"type":"string","description":"Public profile picture URL if set.","uniqueItems":false},"website":{"type":"string","description":"Public profile website URL if set.","uniqueItems":false}},"required":["status"]}},"components/schemas/ConversationMessengerInfoDto":{"id":"components/schemas/ConversationMessengerInfoDto","kind":"json-schema","title":"ConversationMessengerInfoDto","data":{"type":"object","properties":{"status":{"x-enumDescriptions":{"ACTIVE":"The communication channel is active and operating normally.","ERROR":"The communication channel has encountered an operational error and is disabled.","FAILING":"The communication channel is failing validation or delivery metrics and requires troubleshooting.","PENDING":"The communication channel setup or verification is pending system completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Channel integration status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/ConversationChannelStatusEnum"}]},"statusDescription":{"type":"string","description":"Channel integration description if status is ERROR or FAILED.","uniqueItems":false},"id":{"type":"string","description":"The ID of the page.","uniqueItems":false},"name":{"type":"string","description":"The name of the page.","uniqueItems":false},"globalBrandPageName":{"type":"string","description":"The name of the Page with country codes appended for Global Pages. Only visible to the Page admin.","uniqueItems":false}},"required":["status"]}},"components/schemas/RcsAccountNotificationTypeEnum":{"id":"components/schemas/RcsAccountNotificationTypeEnum","kind":"json-schema","title":"RcsAccountNotificationTypeEnum","data":{"type":"string","enum":["COMMENT_ADDED","CREATED"]}},"components/schemas/RcsAccountNotificationDto":{"id":"components/schemas/RcsAccountNotificationDto","kind":"json-schema","title":"RcsAccountNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsAccountNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/RcsAccountNotificationListDto":{"id":"components/schemas/RcsAccountNotificationListDto","kind":"json-schema","title":"RcsAccountNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/RcsAccountNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/RcsPapiErrorDto":{"id":"components/schemas/RcsPapiErrorDto","kind":"json-schema","title":"RcsPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/RcsCommentTypeEnum":{"id":"components/schemas/RcsCommentTypeEnum","kind":"json-schema","title":"RcsCommentTypeEnum","data":{"type":"string","const":"CREATED"}},"components/schemas/RcsCommentDto":{"id":"components/schemas/RcsCommentDto","kind":"json-schema","title":"RcsCommentDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"CREATED":"Indicates the comment has been successfully created and published."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsCommentTypeEnum"}]},"comment":{"type":"string","uniqueItems":false},"created":{"type":"string","uniqueItems":false}},"required":["type","comment"]}},"components/schemas/RcsCommentInputDto":{"id":"components/schemas/RcsCommentInputDto","kind":"json-schema","title":"RcsCommentInputDto","data":{"type":"object","properties":{"comment":{"type":"string","minLength":1,"maxLength":65535,"uniqueItems":false}},"required":["comment"]}},"components/schemas/RcsOperatorStatusEnum":{"id":"components/schemas/RcsOperatorStatusEnum","kind":"json-schema","title":"RcsOperatorStatusEnum","data":{"type":"string","enum":["LAUNCHED","NOT_LAUNCHED","PENDING","PENDING_UNLAUNCHED","REJECTED","SUSPENDED","UNLAUNCHED","INVALID_IN_GOOGLE_MY_BUSINESS","UNRECOGNIZED"],"description":"Operator status."}},"components/schemas/RcsOperatorDto":{"id":"components/schemas/RcsOperatorDto","kind":"json-schema","title":"RcsOperatorDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Operator name.","uniqueItems":false},"status":{"x-enumDescriptions":{"LAUNCHED":"The operator has been launched and is active.","NOT_LAUNCHED":"The operator has not been launched yet.","PENDING":"The operator configuration is pending activation.","PENDING_UNLAUNCHED":"The operator is pending unlaunch execution.","REJECTED":"The operator configuration has been rejected.","SUSPENDED":"The operator has been suspended and is temporarily inactive.","UNLAUNCHED":"The operator has been unlaunched and is no longer active.","INVALID_IN_GOOGLE_MY_BUSINESS":"The operator profile is invalid within Google My Business.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Operator status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsOperatorStatusEnum"}]},"remark":{"type":"string","description":"Any comments or notes to the current state.","uniqueItems":false},"modified":{"type":"string","description":"Last date the operator changed state.","uniqueItems":false}},"required":["name","status"]}},"components/schemas/RcsCountryCodesEnum":{"id":"components/schemas/RcsCountryCodesEnum","kind":"json-schema","title":"RcsCountryCodesEnum","data":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","UNRECOGNIZED"],"description":"Two-letter country code in ISO 3166 standard."}},"components/schemas/RcsCountryStatusDto":{"id":"components/schemas/RcsCountryStatusDto","kind":"json-schema","title":"RcsCountryStatusDto","data":{"type":"object","properties":{"country":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AQ":"The country code for Antarctica.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Two-letter country code in ISO 3166 standard.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsCountryCodesEnum"}]},"status":{"x-enumDescriptions":{"LAUNCHED":"The operator has been launched and is active.","NOT_LAUNCHED":"The operator has not been launched yet.","PENDING":"The operator configuration is pending activation.","PENDING_UNLAUNCHED":"The operator is pending unlaunch execution.","REJECTED":"The operator configuration has been rejected.","SUSPENDED":"The operator has been suspended and is temporarily inactive.","UNLAUNCHED":"The operator has been unlaunched and is no longer active.","INVALID_IN_GOOGLE_MY_BUSINESS":"The operator profile is invalid within Google My Business.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Country status.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsOperatorStatusEnum"}]},"operators":{"type":"array","items":{"$ref":"#/components/schemas/RcsOperatorDto"},"description":"Mobile network operators.","uniqueItems":false}},"required":["country","status","operators"]}},"components/schemas/RcsTestNumberStatesEnum":{"id":"components/schemas/RcsTestNumberStatesEnum","kind":"json-schema","title":"RcsTestNumberStatesEnum","data":{"type":"string","enum":["DECLINED","EXPIRED","FAILED","INVALID","PENDING","REJECTED","UNVERIFIED","VERIFIED","UNRECOGNIZED"],"description":"Test phone state."}},"components/schemas/RcsTestNumberStateDto":{"id":"components/schemas/RcsTestNumberStateDto","kind":"json-schema","title":"RcsTestNumberStateDto","data":{"type":"object","properties":{"number":{"type":"string","format":"e.164 phone number","description":"Test phone number.","uniqueItems":false},"state":{"x-enumDescriptions":{"DECLINED":"The test number registration has been declined by the system or operator.","EXPIRED":"The test user did not respond to the verification invite before it expired.","FAILED":"The test number could not be added after all attempts were exhausted.","INVALID":"The test number configuration or format is invalid.","PENDING":"The test number verification is pending backend or operator approval.","REJECTED":"The test number verification has been rejected.","UNVERIFIED":"The test number has not been verified yet.","VERIFIED":"The test number has been successfully verified and is ready for use.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Test phone state.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsTestNumberStatesEnum"}]},"submitted":{"type":"string","description":"Date of submitting phone number.","uniqueItems":false}},"required":["number","state","submitted"]}},"components/schemas/RcsConversationApiAppRegionsEnum":{"id":"components/schemas/RcsConversationApiAppRegionsEnum","kind":"json-schema","title":"RcsConversationApiAppRegionsEnum","data":{"type":"string","enum":["BR","EU","US","UNRECOGNIZED"],"description":"App region."}},"components/schemas/RcsConversationAppChannelIntegrationStatusEnum":{"id":"components/schemas/RcsConversationAppChannelIntegrationStatusEnum","kind":"json-schema","title":"RcsConversationAppChannelIntegrationStatusEnum","data":{"type":"string","enum":["ACTIVE","FAILING","PENDING","UNRECOGNIZED"],"description":"Status of the channel credentials integration."}},"components/schemas/RcsConversationApiAppDto":{"id":"components/schemas/RcsConversationApiAppDto","kind":"json-schema","title":"RcsConversationApiAppDto","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the app","uniqueItems":false},"projectId":{"type":"string","description":"ID of the app project","uniqueItems":false},"region":{"x-enumDescriptions":{"BR":"The application operates within the Brazil region.","EU":"The application operates within the Europe region.","US":"The application operates within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"App region.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsConversationApiAppRegionsEnum"}]},"channelStatus":{"x-enumDescriptions":{"ACTIVE":"The channel integration is active and operating as expected.","FAILING":"The channel integration is failing and requires manual attention or troubleshooting.","PENDING":"The channel integration setup or synchronization is pending completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Status of the channel credentials integration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsConversationAppChannelIntegrationStatusEnum"}]}},"required":["id","projectId","region"]}},"components/schemas/RcsSenderStatesEnum":{"id":"components/schemas/RcsSenderStatesEnum","kind":"json-schema","title":"RcsSenderStatesEnum","data":{"type":"string","enum":["DRAFT","IN_PROGRESS","IN_TEST","LAUNCHED","LAUNCHING","PREPARING_LAUNCH","UNLAUNCHED","UNKNOWN"],"description":"The current state of the sender."}},"components/schemas/RcsEmailDto":{"id":"components/schemas/RcsEmailDto","kind":"json-schema","title":"RcsEmailDto","data":{"type":"object","properties":{"label":{"type":"string","description":"Contact email label.","uniqueItems":false},"address":{"type":"string","format":"email","description":"Contact email address.","uniqueItems":false}},"required":["label","address"]}},"components/schemas/RcsPhoneDto":{"id":"components/schemas/RcsPhoneDto","kind":"json-schema","title":"RcsPhoneDto","data":{"type":"object","properties":{"label":{"type":"string","description":"Contact phone label.","uniqueItems":false},"number":{"type":"string","description":"Contact phone number. A phone number without country code and without separators, or a valid e.164 phone number.","uniqueItems":false}},"required":["label","number"]}},"components/schemas/RcsWebsiteDto":{"id":"components/schemas/RcsWebsiteDto","kind":"json-schema","title":"RcsWebsiteDto","data":{"type":"object","properties":{"label":{"type":"string","description":"Contact website label.","uniqueItems":false},"url":{"type":"string","format":"url","description":"Contact website address.","uniqueItems":false}},"required":["label","url"]}},"components/schemas/RcsSenderDetailsBrandDto":{"id":"components/schemas/RcsSenderDetailsBrandDto","kind":"json-schema","title":"RcsSenderDetailsBrandDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Brand name.","uniqueItems":false},"emails":{"type":"array","items":{"$ref":"#/components/schemas/RcsEmailDto"},"description":"Contact emails.","uniqueItems":false},"phones":{"type":"array","items":{"$ref":"#/components/schemas/RcsPhoneDto"},"description":"Contact phone numbers.","uniqueItems":false},"websites":{"type":"array","items":{"$ref":"#/components/schemas/RcsWebsiteDto"},"description":"Contact websites.","uniqueItems":false},"color":{"type":"string","format":"hex","description":"Brand color (HEX code).","uniqueItems":false},"description":{"type":"string","description":"Brand description.","uniqueItems":false},"bannerUrl":{"type":"string","format":"url","description":"Brand banner url.","uniqueItems":false},"logoUrl":{"type":"string","format":"url","description":"Brand logo url.","uniqueItems":false},"privacyPolicyUrl":{"type":"string","format":"url","description":"Privacy Policy URL.","uniqueItems":false},"termsOfServiceUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions URL."},"children":[]}]}]}],"uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireQuestionObjectDto","data":{"type":"object","properties":{"question":{"type":"string","readOnly":true,"description":"Human readable question.","uniqueItems":false},"suggestedAnswers":{"readOnly":true,"description":"Suggested answers to the question.","uniqueItems":false,"type":"array","items":{"type":"string"}}},"required":["question","suggestedAnswers"]}},"components/schemas/RcsSenderDetailsQuestionnaireGeneralQuestionsDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGeneralQuestionsDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGeneralQuestionsDto","data":{"type":"object","properties":{"optInDescription":{"readOnly":true,"description":"How you obtain opt-in to message users.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"triggerDescription":{"readOnly":true,"description":"Actions that triggers messages to users.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"interactionsDescription":{"readOnly":true,"description":"Interactions with users.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optOutDescription":{"readOnly":true,"description":"The message the sender sends when a user opts out.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"videoUris":{"readOnly":true,"description":"Publicly available URIs for videos of the sender, for review purposes only.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"screenshotUris":{"readOnly":true,"description":"Publicly available URIs for screenshots of the sender, for review purposes only.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["optInDescription","triggerDescription","interactionsDescription","optOutDescription","videoUris","screenshotUris"]}},"components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireAnswerMetadataDto","data":{"type":"object","properties":{"ignore":{"type":"string","description":"Ignore given string on launch, e.g. custom delimiter.","uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGeneralAnswersDto","data":{"type":"object","properties":{"optInDescription":{"type":"string","description":"How you obtain opt-in to message users.","uniqueItems":false},"optInDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"triggerDescription":{"type":"string","description":"Actions that triggers messages to users.","uniqueItems":false},"triggerDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"interactionsDescription":{"type":"string","description":"Interactions with users.","uniqueItems":false},"interactionsDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"optOutDescription":{"type":"string","description":"The message the sender sends when a user opts out.","uniqueItems":false},"optOutDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"videoUris":{"description":"Publicly available URIs for videos of the sender, for review purposes only.","uniqueItems":false,"type":"array","items":{"type":"string","format":"url"}},"screenshotUris":{"description":"Publicly available URIs for screenshots of the sender, for review purposes only.","uniqueItems":false,"type":"array","items":{"type":"string","format":"url"}}}}},"components/schemas/RcsSenderDetailsQuestionnaireGeneralDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGeneralDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGeneralDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralQuestionsDto"}]},"answers":{"description":"Launch answers","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersDto"}]}},"required":["questions","answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerQuestionsDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerQuestionsDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationPartnerQuestionsDto","data":{"type":"object","properties":{"companyName":{"readOnly":true,"description":"Company name of the brand partner.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactName":{"readOnly":true,"description":"Name of the contact person of the brand partner.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactEmailAddress":{"readOnly":true,"description":"Email of the contact person of the brand partner.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["companyName","contactName","contactEmailAddress"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationQuestionsDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationQuestionsDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationQuestionsDto","data":{"type":"object","properties":{"name":{"readOnly":true,"description":"Name of verification contact.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"email":{"readOnly":true,"description":"Email of verification contact.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"title":{"readOnly":true,"description":"Title of verification contact.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"website":{"readOnly":true,"description":"Website of verification contact.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"phone":{"readOnly":true,"description":"Phone number of verification contact in E.164 format.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"partner":{"readOnly":true,"description":"Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerQuestionsDto"}]}},"required":["name","email","title","website","phone","partner"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationPartnerAnswersDto","data":{"type":"object","properties":{"companyName":{"type":"string","description":"Company name of the brand partner.","uniqueItems":false},"contactName":{"type":"string","description":"Name of the contact person of the brand partner.","uniqueItems":false},"contactEmailAddress":{"type":"string","format":"email","description":"Email of the contact person of the brand partner.","uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationAnswersDto","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of verification contact.","uniqueItems":false},"email":{"type":"string","format":"email","description":"Email of verification contact.","uniqueItems":false},"title":{"type":"string","description":"Title of verification contact.","uniqueItems":false},"website":{"type":"string","format":"url","description":"Website of verification contact.","uniqueItems":false},"phone":{"type":"string","description":"Phone number of verification contact in E.164 format.","uniqueItems":false},"partner":{"description":"Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersDto"}]}}}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Verification questions.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationQuestionsDto"}]},"answers":{"description":"Verification answers.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersDto"}]}},"required":["questions","answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireGBQuestionsDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGBQuestionsDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGBQuestionsDto","data":{"type":"object","properties":{"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyRegistrationNumber":{"readOnly":true,"description":"The company registration number.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"fullCompanyAddress":{"readOnly":true,"description":"Full company address.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesFrequency":{"readOnly":true,"description":"Messages frequency.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"campaignLength":{"readOnly":true,"description":"Length of campaign.","deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["brandIndustry","companyLegalName","companyRegistrationNumber","fullCompanyAddress","messagesVolume","messagesFrequency","campaignLength"]}},"components/schemas/RcsSenderDetailsQuestionnaireGBAnswersDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGBAnswersDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGBAnswersDto","data":{"type":"object","properties":{"brandIndustry":{"type":"string","description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false},"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false},"companyRegistrationNumber":{"type":"string","description":"The company registration number.","uniqueItems":false},"fullCompanyAddress":{"type":"string","description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"messagesVolume":{"type":"string","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"messagesFrequency":{"type":"string","description":"Messages frequency.","uniqueItems":false},"campaignLength":{"type":"string","description":"Length of campaign.","deprecated":true,"uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireGBDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGBDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGBDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBQuestionsDto"}]},"answers":{"description":"Launch answers specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBAnswersDto"}]}},"required":["questions","answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireFRQuestionsDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireFRQuestionsDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireFRQuestionsDto","data":{"type":"object","properties":{"fullCompanyAddress":{"readOnly":true,"description":"Full company address.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"siren":{"readOnly":true,"description":"Company directory identification system number.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["fullCompanyAddress","siren"]}},"components/schemas/RcsSenderDetailsQuestionnaireFRAnswersDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireFRAnswersDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireFRAnswersDto","data":{"type":"object","properties":{"fullCompanyAddress":{"type":"string","description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"siren":{"type":"string","description":"Company directory identification system number.","uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireFRDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireFRDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireFRDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRQuestionsDto"}]},"answers":{"description":"Launch answers specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRAnswersDto"}]}},"required":["questions","answers"]}},"components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"ownershipType":{"readOnly":true,"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyPhoneNumber":{"readOnly":true,"description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyEmailAddress":{"readOnly":true,"description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandName":{"readOnly":true,"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"legalForm":{"readOnly":true,"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxIdCountry":{"readOnly":true,"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxId":{"readOnly":true,"description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressLine":{"readOnly":true,"description":"Street address line. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCity":{"readOnly":true,"description":"City. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCountry":{"readOnly":true,"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressState":{"readOnly":true,"description":"State (US only). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressPostalCode":{"readOnly":true,"description":"Postal code. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"websiteUrl":{"readOnly":true,"description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactFirstName":{"readOnly":true,"description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactSurname":{"readOnly":true,"description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockExchange":{"readOnly":true,"description":"Primary home country stock exchange abbreviation. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockSymbol":{"readOnly":true,"description":"Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"sampleMessages":{"readOnly":true,"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedLink":{"readOnly":true,"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedPhone":{"readOnly":true,"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ageGatedContent":{"readOnly":true,"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"directLending":{"readOnly":true,"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optInConfirmationMessage":{"readOnly":true,"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"helpMessage":{"readOnly":true,"description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"callToActionMessage":{"readOnly":true,"description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["ownershipType","companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressState","addressPostalCode","websiteUrl","contactFirstName","contactSurname","stockExchange","stockSymbol","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage"]}},"components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"ownershipType":{"readOnly":true,"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyPhoneNumber":{"readOnly":true,"description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyEmailAddress":{"readOnly":true,"description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandName":{"readOnly":true,"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"legalForm":{"readOnly":true,"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxIdCountry":{"readOnly":true,"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxId":{"readOnly":true,"description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressLine":{"readOnly":true,"description":"Street address line. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCity":{"readOnly":true,"description":"City. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCountry":{"readOnly":true,"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressState":{"readOnly":true,"description":"State (US only). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressPostalCode":{"readOnly":true,"description":"Postal code. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"websiteUrl":{"readOnly":true,"description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactFirstName":{"readOnly":true,"description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactSurname":{"readOnly":true,"description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"sampleMessages":{"readOnly":true,"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedLink":{"readOnly":true,"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedPhone":{"readOnly":true,"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ageGatedContent":{"readOnly":true,"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"directLending":{"readOnly":true,"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optInConfirmationMessage":{"readOnly":true,"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"helpMessage":{"readOnly":true,"description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"callToActionMessage":{"readOnly":true,"description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["ownershipType","companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressState","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage"]}},"components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"ownershipType":{"readOnly":true,"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyPhoneNumber":{"readOnly":true,"description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyEmailAddress":{"readOnly":true,"description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandName":{"readOnly":true,"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"legalForm":{"readOnly":true,"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxIdCountry":{"readOnly":true,"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxId":{"readOnly":true,"description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressLine":{"readOnly":true,"description":"Street address line. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCity":{"readOnly":true,"description":"City. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCountry":{"readOnly":true,"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressPostalCode":{"readOnly":true,"description":"Postal code. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"websiteUrl":{"readOnly":true,"description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactFirstName":{"readOnly":true,"description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactSurname":{"readOnly":true,"description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockExchange":{"readOnly":true,"description":"Primary home country stock exchange abbreviation. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockSymbol":{"readOnly":true,"description":"Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"sampleMessages":{"readOnly":true,"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedLink":{"readOnly":true,"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedPhone":{"readOnly":true,"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ageGatedContent":{"readOnly":true,"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"directLending":{"readOnly":true,"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optInConfirmationMessage":{"readOnly":true,"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"helpMessage":{"readOnly":true,"description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"callToActionMessage":{"readOnly":true,"description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["ownershipType","companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","stockExchange","stockSymbol","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage"]}},"components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"ownershipType":{"readOnly":true,"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyPhoneNumber":{"readOnly":true,"description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyEmailAddress":{"readOnly":true,"description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandName":{"readOnly":true,"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"legalForm":{"readOnly":true,"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxIdCountry":{"readOnly":true,"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxId":{"readOnly":true,"description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressLine":{"readOnly":true,"description":"Street address line. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCity":{"readOnly":true,"description":"City. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCountry":{"readOnly":true,"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressPostalCode":{"readOnly":true,"description":"Postal code. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"websiteUrl":{"readOnly":true,"description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactFirstName":{"readOnly":true,"description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactSurname":{"readOnly":true,"description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"sampleMessages":{"readOnly":true,"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedLink":{"readOnly":true,"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedPhone":{"readOnly":true,"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ageGatedContent":{"readOnly":true,"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"directLending":{"readOnly":true,"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optInConfirmationMessage":{"readOnly":true,"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"helpMessage":{"readOnly":true,"description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"callToActionMessage":{"readOnly":true,"description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["ownershipType","companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage"]}},"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"ownershipType":{"readOnly":true,"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyPhoneNumber":{"readOnly":true,"description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyEmailAddress":{"readOnly":true,"description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandName":{"readOnly":true,"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"legalForm":{"readOnly":true,"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxIdCountry":{"readOnly":true,"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxId":{"readOnly":true,"description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressLine":{"readOnly":true,"description":"Street address line. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCity":{"readOnly":true,"description":"City. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCountry":{"readOnly":true,"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressState":{"readOnly":true,"description":"State (US only). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressPostalCode":{"readOnly":true,"description":"Postal code. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"websiteUrl":{"readOnly":true,"description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactFirstName":{"readOnly":true,"description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactSurname":{"readOnly":true,"description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockExchange":{"readOnly":true,"description":"Primary home country stock exchange abbreviation. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockSymbol":{"readOnly":true,"description":"Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"sampleMessages":{"readOnly":true,"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedLink":{"readOnly":true,"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedPhone":{"readOnly":true,"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ageGatedContent":{"readOnly":true,"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"directLending":{"readOnly":true,"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optInConfirmationMessage":{"readOnly":true,"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"helpMessage":{"readOnly":true,"description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"callToActionMessage":{"readOnly":true,"description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["ownershipType","companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressState","addressPostalCode","websiteUrl","contactFirstName","contactSurname","stockExchange","stockSymbol","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage"]}},"components/schemas/RcsUsQuestionnaireOwnershipTypeEnum":{"id":"components/schemas/RcsUsQuestionnaireOwnershipTypeEnum","kind":"json-schema","title":"RcsUsQuestionnaireOwnershipTypeEnum","data":{"type":"string","enum":["PRIVATE","PUBLIC"],"description":"Ownership type of the company. Not required for create, but required for launch."}},"components/schemas/RcsUsQuestionnaireBrandIndustriesEnum":{"id":"components/schemas/RcsUsQuestionnaireBrandIndustriesEnum","kind":"json-schema","title":"RcsUsQuestionnaireBrandIndustriesEnum","data":{"type":"string","enum":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"],"description":"Sector or industry of business. Not required for create, but required for launch."}},"components/schemas/RcsUsQuestionnaireBrandLegalFormsEnum":{"id":"components/schemas/RcsUsQuestionnaireBrandLegalFormsEnum","kind":"json-schema","title":"RcsUsQuestionnaireBrandLegalFormsEnum","data":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"],"description":"Legal form of the company."}},"components/schemas/RcsInputCountryCodesEnum":{"id":"components/schemas/RcsInputCountryCodesEnum","kind":"json-schema","title":"RcsInputCountryCodesEnum","data":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Country of the company's tax registration."}},"components/schemas/RcsUsStatesEnum":{"id":"components/schemas/RcsUsStatesEnum","kind":"json-schema","title":"RcsUsStatesEnum","data":{"type":"string","enum":["AK","AL","AR","AS","AZ","CA","CO","CT","DC","DE","FL","GA","GU","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MI","MN","MO","MP","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VA","VI","VT","WA","WI","WV","WY"],"description":"State (US only). Not required for create, but required for launch."}},"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto":{"id":"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto","kind":"json-schema","title":"RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto","data":{"type":"object","properties":{"ownershipType":{"x-enumDescriptions":{"PRIVATE":"The brand is a privately owned entity.","PUBLIC":"The brand is a publicly traded company."},"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireOwnershipTypeEnum"}]},"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false},"companyPhoneNumber":{"type":"string","description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false},"companyEmailAddress":{"type":"string","format":"email","description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false},"brandName":{"type":"string","description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false},"brandIndustry":{"x-enumDescriptions":{"AGRICULTURE":"The brand operates within the agriculture sector.","COMMUNICATION":"The brand operates within the communication industry.","CONSTRUCTION":"The brand operates within the construction sector.","EDUCATION":"The brand operates within the education field.","ENERGY":"The brand operates within the energy and utilities sector.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","FINANCIAL":"The brand operates within the financial services sector.","GAMBLING":"The brand operates within the gambling or betting industry.","GOVERNMENT":"The brand is a government or public administration entity.","HEALTHCARE":"The brand operates within the healthcare and medical sector.","HOSPITALITY":"The brand operates within hospitality, tourism, or food services.","HUMAN_RESOURCES":"The brand operates within human resources and staffing services.","INSURANCE":"The brand operates within the insurance sector.","LEGAL":"The brand operates within legal services.","MANUFACTURING":"The brand operates within the manufacturing sector.","NON_GOVERNMENTAL_ORGANIZATION":"The brand is a non-governmental organization (NGO).","POLITICAL":"The brand is a political organization or campaign.","POSTAL":"The brand operates within postal, courier, or delivery services.","PROFESSIONAL":"The brand provides professional, scientific, or technical services.","REAL_ESTATE":"The brand operates within the real estate market.","RETAIL":"The brand operates within retail or wholesale commerce.","TECHNOLOGY":"The brand operates within the technology and software sector.","TRANSPORTATION":"The brand operates within transportation or logistics services."},"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum"}]},"legalForm":{"x-enumDescriptions":{"CORPORATION":"The company is registered as a Corporation.","LIMITED_LIABILITY_COMPANY":"The company is registered as a Limited Liability Company (LLC).","PARTNERSHIP":"The company is registered as a Partnership.","S_CORPORATION":"The company is registered as an S Corporation."},"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandLegalFormsEnum"}]},"taxIdCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"taxId":{"type":"string","description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false},"addressLine":{"type":"string","description":"Street address line. Not required for create, but required for launch.","uniqueItems":false},"addressCity":{"type":"string","description":"City. Not required for create, but required for launch.","uniqueItems":false},"addressCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"addressState":{"x-enumDescriptions":{"AK":"The State of Alaska.","AL":"The State of Alabama.","AR":"The State of Arkansas.","AS":"The US territory of American Samoa.","AZ":"The State of Arizona.","CA":"The State of California.","CO":"The State of Colorado.","CT":"The State of Connecticut.","DC":"The District of Columbia.","DE":"The State of Delaware.","FL":"The State of Florida.","GA":"The State of Georgia.","GU":"The US territory of Guam.","HI":"The State of Hawaii.","IA":"The State of Iowa.","ID":"The State of Idaho.","IL":"The State of Illinois.","IN":"The State of Indiana.","KS":"The State of Kansas.","KY":"The Commonwealth of Kentucky.","LA":"The State of Louisiana.","MA":"The Commonwealth of Massachusetts.","MD":"The State of Maryland.","ME":"The State of Maine.","MI":"The State of Michigan.","MN":"The State of Minnesota.","MO":"The State of Missouri.","MP":"The US Commonwealth of the Northern Mariana Islands.","MS":"The State of Mississippi.","MT":"The State of Montana.","NC":"The State of North Carolina.","ND":"The State of North Dakota.","NE":"The State of Nebraska.","NH":"The State of New Hampshire.","NJ":"The State of New Jersey.","NM":"The State of New Mexico.","NV":"The State of Nevada.","NY":"The State of New York.","OH":"The State of Ohio.","OK":"The State of Oklahoma.","OR":"The State of Oregon.","PA":"The Commonwealth of Pennsylvania.","PR":"The US territory of Puerto Rico.","RI":"The State of Rhode Island.","SC":"The State of South Carolina.","SD":"The State of South Dakota.","TN":"The State of Tennessee.","TX":"The State of Texas.","UT":"The State of Utah.","VA":"The Commonwealth of Virginia.","VI":"The US territory of the Virgin Islands.","VT":"The State of Vermont.","WA":"The State of Washington.","WI":"The State of Wisconsin.","WV":"The State of West Virginia.","WY":"The State of Wyoming."},"description":"State (US only). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsStatesEnum"}]},"addressPostalCode":{"type":"string","description":"Postal code. Not required for create, but required for launch.","uniqueItems":false},"websiteUrl":{"type":"string","description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false},"contactFirstName":{"type":"string","description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false},"contactSurname":{"type":"string","description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false},"stockExchange":{"type":"string","description":"Primary home country stock exchange abbreviation. Not required for create, but required for launch.","uniqueItems":false},"stockSymbol":{"type":"string","description":"Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.","uniqueItems":false},"sampleMessages":{"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"type":"array","items":{"type":"string"}},"messagesVolume":{"type":"number","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"embeddedLink":{"type":"boolean","description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"embeddedPhone":{"type":"boolean","description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"ageGatedContent":{"type":"boolean","description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false},"directLending":{"type":"boolean","description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false},"optInConfirmationMessage":{"type":"string","description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false},"helpMessage":{"type":"string","description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false},"callToActionMessage":{"type":"string","description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false}}}},"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSDto":{"id":"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSDto","kind":"json-schema","title":"RcsBrandCampaignSenderDetailsQuestionnaireUSDto","data":{"type":"object","properties":{"questions":{"oneOf":[{"$ref":"#/components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"}],"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false},"answers":{"description":"Launch answers specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto"}]}},"required":["questions","answers"]}},"components/schemas/RcsDefaultSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsDefaultSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsDefaultSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"ownershipType":{"readOnly":true,"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyPhoneNumber":{"readOnly":true,"description":"The registered phone number of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"companyEmailAddress":{"readOnly":true,"description":"The email address of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandName":{"readOnly":true,"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"legalForm":{"readOnly":true,"description":"Legal form of the company.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxIdCountry":{"readOnly":true,"description":"Country of the company's tax registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"taxId":{"readOnly":true,"description":"Tax registration identifier associated with the provided legal company name.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressLine":{"readOnly":true,"description":"Street address line. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCity":{"readOnly":true,"description":"City. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressCountry":{"readOnly":true,"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressState":{"readOnly":true,"description":"State (US only). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"addressPostalCode":{"readOnly":true,"description":"Postal code. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"websiteUrl":{"readOnly":true,"description":"Primary website URL. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactFirstName":{"readOnly":true,"description":"First name of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"contactSurname":{"readOnly":true,"description":"Surname of the responsible contact person. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockExchange":{"readOnly":true,"description":"Primary home country stock exchange abbreviation. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"stockSymbol":{"readOnly":true,"description":"Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"sampleMessages":{"readOnly":true,"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedLink":{"readOnly":true,"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"embeddedPhone":{"readOnly":true,"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ageGatedContent":{"readOnly":true,"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"directLending":{"readOnly":true,"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"optInConfirmationMessage":{"readOnly":true,"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"helpMessage":{"readOnly":true,"description":"Help message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"callToActionMessage":{"readOnly":true,"description":"Call to action message of the campaign. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ein":{"readOnly":true,"description":"Employer Identification Number (EIN).","deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"fullCompanyAddress":{"readOnly":true,"description":"Full company address.","deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"smsCampaign":{"readOnly":true,"description":"US SMS campaign used as fallback.","deprecated":true,"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"required":["ownershipType","companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","legalForm","taxIdCountry","taxId","addressLine","addressCity","addressCountry","addressState","addressPostalCode","websiteUrl","contactFirstName","contactSurname","stockExchange","stockSymbol","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","ein","fullCompanyAddress","smsCampaign"]}},"components/schemas/RcsDefaultSenderDetailsQuestionnaireUSDto":{"id":"components/schemas/RcsDefaultSenderDetailsQuestionnaireUSDto","kind":"json-schema","title":"RcsDefaultSenderDetailsQuestionnaireUSDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsDefaultSenderDetailsQuestionnaireUSQuestionsDto"}]},"answers":{"description":"Launch answers specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto"}]}},"required":["questions","answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireUSQuestionsDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireUSQuestionsDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireUSQuestionsDto","data":{"type":"object","properties":{"companyLegalName":{"readOnly":true,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"ein":{"readOnly":true,"description":"Employer Identification Number (EIN).","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"brandIndustry":{"readOnly":true,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"fullCompanyAddress":{"readOnly":true,"description":"Full company address.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"smsCampaign":{"readOnly":true,"description":"US SMS campaign used as fallback.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]},"messagesVolume":{"readOnly":true,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto"}]}},"description":"SenderDetailsQuestionnaireUSQuestionsDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSQuestionsDto instead.","required":["companyLegalName","ein","brandIndustry","fullCompanyAddress","smsCampaign","messagesVolume"]}},"components/schemas/RcsSenderDetailsQuestionnaireUSAnswersDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireUSAnswersDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireUSAnswersDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false},"ein":{"type":"string","description":"Employer Identification Number (EIN).","uniqueItems":false},"brandIndustry":{"type":"string","description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false},"fullCompanyAddress":{"type":"string","description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto"}]},"smsCampaign":{"type":"string","description":"US SMS campaign used as fallback.","uniqueItems":false},"messagesVolume":{"type":"string","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false}},"description":"SenderDetailsQuestionnaireUSAnswersDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSAnswersDto instead."}},"components/schemas/RcsSenderDetailsQuestionnaireUSDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireUSDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireUSDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSQuestionsDto"}]},"answers":{"description":"Launch answers specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSAnswersDto"}]}},"description":"SenderDetailsQuestionnaireUSDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSDto instead.","required":["questions","answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireDto","data":{"type":"object","properties":{"general":{"description":"General launch questions","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralDto"}]},"verification":{"description":"Verification questions.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationDto"}]},"gb":{"description":"Launch questions specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBDto"}]},"fr":{"description":"Launch questions specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRDto"}]},"us":{"oneOf":[{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSDto"},{"$ref":"#/components/schemas/RcsDefaultSenderDetailsQuestionnaireUSDto"},{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSDto"}],"description":"Launch questions specific for US.","uniqueItems":false}},"required":["general","verification"]}},"components/schemas/RcsSenderDetailsDto":{"id":"components/schemas/RcsSenderDetailsDto","kind":"json-schema","title":"RcsSenderDetailsDto","data":{"type":"object","properties":{"brand":{"description":"Brand information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsBrandDto"}]},"callbackUrl":{"type":"string","format":"url","description":"Use Webhooks instead for sender update events.","deprecated":true,"uniqueItems":false},"testNumbers":{"description":"Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.","uniqueItems":false,"type":"array","items":{"type":"string","format":"e.164 phone number"}},"countries":{"type":"array","x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AQ":"The country code for Antarctica.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in.","uniqueItems":false,"items":{"$ref":"#/components/schemas/RcsCountryCodesEnum"}},"questionnaire":{"description":"\n  Launch questionnaire.\n\n  The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n  ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireDto"}]}},"required":["questionnaire"]}},"components/schemas/RcsSenderRegionsEnum":{"id":"components/schemas/RcsSenderRegionsEnum","kind":"json-schema","title":"RcsSenderRegionsEnum","data":{"type":"string","enum":["BR","EU","US"],"description":"Region sender is provisioned in."}},"components/schemas/RcsSenderBillingCategoriesEnum":{"id":"components/schemas/RcsSenderBillingCategoriesEnum","kind":"json-schema","title":"RcsSenderBillingCategoriesEnum","data":{"type":"string","enum":["CONVERSATIONAL","NON_CONVERSATIONAL","BASIC_MESSAGE","CONVERSATIONAL_LEGACY","SINGLE_MESSAGE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  billing framework distinguishes between two primary categories: non-conversational and conversational."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents.  Deprecated value, use CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]}]}]}},"components/schemas/RcsSenderUseCasesEnum":{"id":"components/schemas/RcsSenderUseCasesEnum","kind":"json-schema","title":"RcsSenderUseCasesEnum","data":{"type":"string","enum":["MULTIUSE","OTP","PROMOTIONAL","TRANSACTIONAL"],"description":"Use case."}},"components/schemas/RcsSenderHostingRegionsEnum":{"id":"components/schemas/RcsSenderHostingRegionsEnum","kind":"json-schema","title":"RcsSenderHostingRegionsEnum","data":{"type":"string","enum":["ASIA_PACIFIC","EUROPE","NORTH_AMERICA"],"description":"Internal Google hosting region"}},"components/schemas/RcsSupplierDetailsGoogleDto":{"id":"components/schemas/RcsSupplierDetailsGoogleDto","kind":"json-schema","title":"RcsSupplierDetailsGoogleDto","data":{"type":"object","properties":{"agentId":{"type":"string","description":"Google agent id.","uniqueItems":false},"brandId":{"type":"string","description":"Google brand id.","uniqueItems":false}}}},"components/schemas/RcsSupplierDetailsDto":{"id":"components/schemas/RcsSupplierDetailsDto","kind":"json-schema","title":"RcsSupplierDetailsDto","data":{"type":"object","properties":{"google":{"description":"Google supplier details.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSupplierDetailsGoogleDto"}]}}}},"components/schemas/RcsBrandRegistrationStatusesEnum":{"id":"components/schemas/RcsBrandRegistrationStatusesEnum","kind":"json-schema","title":"RcsBrandRegistrationStatusesEnum","data":{"type":"string","enum":["ARCHIVED","COMPLETED","DRAFT","UNRECOGNIZED","UNSPECIFIED"],"description":"Current status of the brand registration."}},"components/schemas/RcsBrandRegistrationProcessStatusesEnum":{"id":"components/schemas/RcsBrandRegistrationProcessStatusesEnum","kind":"json-schema","title":"RcsBrandRegistrationProcessStatusesEnum","data":{"type":"string","enum":["ARCHIVED","COMPLETED","INCOMPLETE","MANUAL_REVIEW","NEW","PENDING","PENDING_REVIEW","REJECTED","UNRECOGNIZED","UNSPECIFIED"],"description":"Current status of the brand registration process."}},"components/schemas/RcsBrandRegistrationProcessDto":{"id":"components/schemas/RcsBrandRegistrationProcessDto","kind":"json-schema","title":"RcsBrandRegistrationProcessDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the brand registration process.","uniqueItems":false},"status":{"x-enumDescriptions":{"ARCHIVED":"The brand registration process has been archived.","COMPLETED":"The brand registration process has finished successfully.","INCOMPLETE":"The brand registration process is missing required information.","MANUAL_REVIEW":"The brand registration process requires manual review.","NEW":"The brand registration process is created but has not yet started.","PENDING":"The brand registration process is waiting for the next action.","PENDING_REVIEW":"The brand registration process is currently under review.","REJECTED":"The brand registration process has been reviewed and rejected.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version.","UNSPECIFIED":"The brand registration process status is not specified."},"description":"Current status of the brand registration process.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandRegistrationProcessStatusesEnum"}]}},"required":["id","status"]}},"components/schemas/RcsBrandRegistrationDto":{"id":"components/schemas/RcsBrandRegistrationDto","kind":"json-schema","title":"RcsBrandRegistrationDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the brand registration.","uniqueItems":false},"status":{"x-enumDescriptions":{"ARCHIVED":"The brand registration has been archived and is no longer active.","COMPLETED":"The brand registration has completed successfully.","DRAFT":"The brand registration is saved as a draft and is not yet finalized.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version.","UNSPECIFIED":"The brand registration status is not specified."},"description":"Current status of the brand registration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandRegistrationStatusesEnum"}]},"registration":{"description":"Details of the channel-specific registration process.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandRegistrationProcessDto"}]}},"required":["id","status","registration"]}},"components/schemas/RcsCampaignRegistrationDto":{"id":"components/schemas/RcsCampaignRegistrationDto","kind":"json-schema","title":"RcsCampaignRegistrationDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the campaign registration (campaign hub).","uniqueItems":false},"campaignName":{"type":"string","description":"The user-assigned name of the campaign.","uniqueItems":false},"requestId":{"type":"string","description":"Unique request correlation/tracking identifier.","uniqueItems":false}},"required":["id","campaignName","requestId"]}},"components/schemas/RcsSenderDto":{"id":"components/schemas/RcsSenderDto","kind":"json-schema","title":"RcsSenderDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sender.","uniqueItems":false},"conversationApiApp":{"type":"string","description":"If set, the Conversation API App ID the sender is connected to.","deprecated":true,"uniqueItems":false},"conversationApiAppDetails":{"description":"If set, the details of the Conversation API App the sender is connected to.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsConversationApiAppDto"}]},"state":{"x-enumDescriptions":{"DRAFT":"The sender configuration is saved as a draft.","IN_PROGRESS":"The sender registration or setup is currently in progress.","IN_TEST":"The sender is currently undergoing testing.","LAUNCHED":"The sender has been successfully launched.","LAUNCHING":"The sender launch sequence is currently executing.","PREPARING_LAUNCH":"The sender configuration is being prepared for launch.","UNLAUNCHED":"The sender has been unlaunched and is disabled.","UNKNOWN":"The current state of the sender cannot be determined."},"description":"The current state of the sender.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderStatesEnum"}]},"testNumberStates":{"type":"array","items":{"$ref":"#/components/schemas/RcsTestNumberStateDto"},"description":"Test phone numbers states.","uniqueItems":false},"countryStatus":{"type":"array","items":{"$ref":"#/components/schemas/RcsCountryStatusDto"},"description":"Countries status.","uniqueItems":false},"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsDto"}]},"region":{"x-enumDescriptions":{"BR":"The sender is operating within the Brazil region.","EU":"The sender is operating within the Europe region.","US":"The sender is operating within the United States region."},"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderRegionsEnum"}]},"billingCategory":{"x-enumDescriptions":{"CONVERSATIONAL":"Billing category for conversational messages.","NON_CONVERSATIONAL":"Billing category for non-conversational messages.","BASIC_MESSAGE":"Billing category for basic messages.","CONVERSATIONAL_LEGACY":"Legacy billing category for conversational messages.","SINGLE_MESSAGE":"Billing category for single messages."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  billing framework distinguishes between two primary categories: non-conversational and conversational."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents.  Deprecated value, use CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderBillingCategoriesEnum"}]},"useCase":{"x-enumDescriptions":{"MULTIUSE":"The sender is configured for multiple types of use cases.","OTP":"The sender is used exclusively for one-time passwords.","PROMOTIONAL":"The sender is used for marketing and promotional content.","TRANSACTIONAL":"The sender is used for functional or transactional communications."},"description":"Use case.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderUseCasesEnum"}]},"hostingRegion":{"x-enumDescriptions":{"ASIA_PACIFIC":"The sender is hosted within the Asia-Pacific region.","EUROPE":"The sender is hosted within the Europe region.","NORTH_AMERICA":"The sender is hosted within the North America region."},"description":"Internal Google hosting region","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderHostingRegionsEnum"}]},"authName":{"type":"string","description":"The name is needed to connect the sender to a Conversation API App.","uniqueItems":false},"authToken":{"type":"string","description":"The token is needed to connect the sender to a Conversation API App.","uniqueItems":false},"created":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was created.","uniqueItems":false},"modified":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was last modified.","uniqueItems":false},"supplierDetails":{"description":"Supplier details.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSupplierDetailsDto"}]},"launched":{"type":"string","description":"The UTC Date Time in ISO 8601 for when the sender was last launched.","uniqueItems":false},"brandDetails":{"description":"Brand registration details.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsBrandRegistrationDto"}]},"campaignDetails":{"description":"Campaign registration details.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsCampaignRegistrationDto"}]}},"required":["id","region","billingCategory","useCase","hostingRegion"]}},"components/schemas/RcsSenderListDto":{"id":"components/schemas/RcsSenderListDto","kind":"json-schema","title":"RcsSenderListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"senders":{"type":"array","items":{"$ref":"#/components/schemas/RcsSenderDto"},"description":"List of senders.","uniqueItems":false}},"required":["totalSize","pageSize","senders"]}},"components/schemas/RcsSenderSortColumnsEnum":{"id":"components/schemas/RcsSenderSortColumnsEnum","kind":"json-schema","title":"RcsSenderSortColumnsEnum","data":{"type":"string","enum":["CREATED","MODIFIED","NAME","STATE"]}},"components/schemas/RcsSortDirectionsEnum":{"id":"components/schemas/RcsSortDirectionsEnum","kind":"json-schema","title":"RcsSortDirectionsEnum","data":{"type":"string","enum":["ASC","DESC"]}},"components/schemas/RcsInputSenderRegionsEnum":{"id":"components/schemas/RcsInputSenderRegionsEnum","kind":"json-schema","title":"RcsInputSenderRegionsEnum","data":{"type":"string","enum":["BR","EU","US"],"description":"Region sender is provisioned in."}},"components/schemas/RcsInputSenderBillingCategoriesEnum":{"id":"components/schemas/RcsInputSenderBillingCategoriesEnum","kind":"json-schema","title":"RcsInputSenderBillingCategoriesEnum","data":{"type":"string","enum":["CONVERSATIONAL","NON_CONVERSATIONAL","BASIC_MESSAGE","CONVERSATIONAL_LEGACY","SINGLE_MESSAGE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  billing framework distinguishes between two primary categories: non-conversational and conversational."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents.  Deprecated value, use CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]}]}]}},"components/schemas/RcsInputSenderUseCasesEnum":{"id":"components/schemas/RcsInputSenderUseCasesEnum","kind":"json-schema","title":"RcsInputSenderUseCasesEnum","data":{"type":"string","enum":["MULTIUSE","OTP","PROMOTIONAL","TRANSACTIONAL"],"description":"Use case."}},"components/schemas/RcsEmailInputDto":{"id":"components/schemas/RcsEmailInputDto","kind":"json-schema","title":"RcsEmailInputDto","data":{"type":"object","properties":{"label":{"type":"string","minLength":0,"maxLength":25,"description":"Contact email label.","uniqueItems":false},"address":{"type":"string","format":"email","description":"Contact email address.","uniqueItems":false}},"required":["label","address"]}},"components/schemas/RcsPhoneInputDto":{"id":"components/schemas/RcsPhoneInputDto","kind":"json-schema","title":"RcsPhoneInputDto","data":{"type":"object","properties":{"label":{"type":"string","minLength":0,"maxLength":25,"description":"Contact phone label.","uniqueItems":false},"number":{"type":"string","pattern":"^\\+?[\\d+\\s]{6,15}$","minLength":6,"maxLength":15,"description":"Contact phone number. Must be a phone number without country code and without separators, or a valid e.164 phone number.","uniqueItems":false}},"required":["label","number"]}},"components/schemas/RcsWebsiteInputDto":{"id":"components/schemas/RcsWebsiteInputDto","kind":"json-schema","title":"RcsWebsiteInputDto","data":{"type":"object","properties":{"label":{"type":"string","minLength":0,"maxLength":25,"description":"Contact website label.","uniqueItems":false},"url":{"type":"string","format":"url","maxLength":255,"description":"Contact website address.","uniqueItems":false}},"required":["label","url"]}},"components/schemas/RcsSenderDetailsBrandInputDto":{"id":"components/schemas/RcsSenderDetailsBrandInputDto","kind":"json-schema","title":"RcsSenderDetailsBrandInputDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":0,"maxLength":40,"description":"Brand name.","default":"RCS Sender","uniqueItems":false},"emails":{"minItems":1,"maxItems":3,"description":"Contact emails. Field 'address' must have unique values across items.","uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/RcsEmailInputDto"}},"phones":{"minItems":1,"maxItems":3,"description":"Contact phone numbers. Field 'number' must have unique values across items.","uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/RcsPhoneInputDto"}},"websites":{"minItems":1,"maxItems":3,"description":"Contact websites. Field 'url' must have unique values across items.","uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/RcsWebsiteInputDto"}},"color":{"type":"string","format":"hex","description":"Brand color (HEX code).","default":"#000000","uniqueItems":false},"description":{"type":"string","minLength":0,"maxLength":100,"description":"Brand description.","uniqueItems":false},"bannerUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand banner url."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 200KB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact image dimensions: 1440 x 448 px."},"children":[]}]}]}]}],"uniqueItems":false},"logoUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand logo url."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 50KB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact image dimensions: 224 x 224 px."},"children":[]}]}]}]}],"uniqueItems":false},"privacyPolicyUrl":{"type":"string","format":"url","description":"Privacy Policy URL.","uniqueItems":false},"termsOfServiceUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions URL."},"children":[]}]}]}],"uniqueItems":false}}}},"components/schemas/RcsInputRcsCountryCodesEnum":{"id":"components/schemas/RcsInputRcsCountryCodesEnum","kind":"json-schema","title":"RcsInputRcsCountryCodesEnum","data":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","LT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"],"description":"List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in."}},"components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireAnswerMetadataInputDto","data":{"type":"object","properties":{"ignore":{"type":"string","minLength":1,"description":"Ignore given string on launch, e.g. custom delimiter.","uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGeneralAnswersInputDto","data":{"type":"object","properties":{"optInDescription":{"type":"string","minLength":1,"description":"How you obtain opt-in to message users.","uniqueItems":false},"optInDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"triggerDescription":{"type":"string","minLength":1,"description":"Actions that triggers messages to users.","uniqueItems":false},"triggerDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"interactionsDescription":{"type":"string","minLength":1,"description":"Interactions with users.","uniqueItems":false},"interactionsDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"optOutDescription":{"type":"string","minLength":1,"description":"The message the sender sends when a user opts out.","uniqueItems":false},"optOutDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"videoUris":{"minItems":1,"description":"Publicly available URIs for videos of the sender, for review purposes only.","uniqueItems":false,"type":"array","items":{"type":"string","format":"url"}},"screenshotUris":{"minItems":1,"description":"Publicly available URIs for screenshots of the sender, for review purposes only.","uniqueItems":false,"type":"array","items":{"type":"string","format":"url"}}}}},"components/schemas/RcsSenderDetailsQuestionnaireGeneralInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGeneralInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGeneralInputDto","data":{"type":"object","properties":{"answers":{"description":"Launch answers","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto","data":{"type":"object","properties":{"companyName":{"type":"string","minLength":1,"maxLength":100,"description":"Company name of the brand partner.","uniqueItems":false},"contactName":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the contact person of the brand partner.","uniqueItems":false},"contactEmailAddress":{"type":"string","format":"email","maxLength":100,"description":"Email of the contact person of the brand partner.","uniqueItems":false}}}},"components/schemas/RcsUsSenderDetailsQuestionnaireVerificationAnswersInputDto":{"id":"components/schemas/RcsUsSenderDetailsQuestionnaireVerificationAnswersInputDto","kind":"json-schema","title":"RcsUsSenderDetailsQuestionnaireVerificationAnswersInputDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Name of verification contact. Not required for create, but required for launch.","uniqueItems":false},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of verification contact. Not required for create, but required for launch.","uniqueItems":false},"title":{"type":"string","minLength":1,"maxLength":100,"description":"Title of verification contact.","uniqueItems":false},"website":{"type":"string","format":"url","description":"Website of verification contact. Not required for create, but required for launch.","uniqueItems":false},"partner":{"description":"Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto"}]},"phone":{"type":"string","pattern":"^(?:\\+|00)\\d{6,15}$","minLength":1,"maxLength":17,"description":"Phone number of verification contact in E.164 format. Required for launch when the sender uses the US country questionnaire version v2, otherwise optional.","uniqueItems":false}},"description":"Verification answers for senders with the US country questionnaire.","required":["name","email","website","phone"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationAnswersInputDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Name of verification contact. Not required for create, but required for launch.","uniqueItems":false},"email":{"type":"string","format":"email","maxLength":100,"description":"Email of verification contact. Not required for create, but required for launch.","uniqueItems":false},"title":{"type":"string","minLength":1,"maxLength":100,"description":"Title of verification contact.","uniqueItems":false},"website":{"type":"string","format":"url","description":"Website of verification contact. Not required for create, but required for launch.","uniqueItems":false},"phone":{"type":"string","pattern":"^(?:\\+|00)\\d{6,15}$","minLength":1,"maxLength":17,"description":"Phone number of verification contact in E.164 format. Required for launch when the sender uses the US country questionnaire version v2, otherwise optional.","uniqueItems":false},"partner":{"description":"Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto"}]}},"description":"Verification answers for senders without the US country questionnaire.","required":["name","email","website"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationInputDto","data":{"type":"object","properties":{"answers":{"oneOf":[{"$ref":"#/components/schemas/RcsUsSenderDetailsQuestionnaireVerificationAnswersInputDto"},{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto"}],"description":"Verification answers. Senders using the US country questionnaire version v2 must also provide phone on launch, all other senders only provide name, email and website.","uniqueItems":false}},"required":["answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireGBAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGBAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGBAnswersInputDto","data":{"type":"object","properties":{"brandIndustry":{"type":"string","minLength":1,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false},"companyLegalName":{"type":"string","minLength":1,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false},"companyRegistrationNumber":{"type":"string","minLength":1,"description":"The company registration number.","uniqueItems":false},"fullCompanyAddress":{"type":"string","minLength":1,"description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"messagesVolume":{"type":"string","minLength":1,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"messagesFrequency":{"type":"string","minLength":1,"description":"Messages frequency.","uniqueItems":false},"campaignLength":{"type":"string","minLength":1,"description":"Length of campaign.","deprecated":true,"uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireGBInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGBInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGBInputDto","data":{"type":"object","properties":{"answers":{"description":"Launch answers specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireFRAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireFRAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireFRAnswersInputDto","data":{"type":"object","properties":{"fullCompanyAddress":{"type":"string","minLength":1,"description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"siren":{"type":"string","pattern":"^\\d+$","minLength":9,"maxLength":9,"description":"Company directory identification system number.","uniqueItems":false}}}},"components/schemas/RcsSenderDetailsQuestionnaireFRInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireFRInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireFRInputDto","data":{"type":"object","properties":{"answers":{"description":"Launch answers specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsUsQuestionnaireOwnershipTypePublicEnum":{"id":"components/schemas/RcsUsQuestionnaireOwnershipTypePublicEnum","kind":"json-schema","title":"RcsUsQuestionnaireOwnershipTypePublicEnum","data":{"type":"string","const":"PUBLIC","description":"Ownership type of the company. Not required for create, but required for launch."}},"components/schemas/RcsPublicUsQuestionnaireBrandLegalFormsEnum":{"id":"components/schemas/RcsPublicUsQuestionnaireBrandLegalFormsEnum","kind":"json-schema","title":"RcsPublicUsQuestionnaireBrandLegalFormsEnum","data":{"type":"string","const":"CORPORATION","description":"Legal form of the company for public ownership type. Not required for create, but required for launch."}},"components/schemas/RcsInputCountryCodesUsEnum":{"id":"components/schemas/RcsInputCountryCodesUsEnum","kind":"json-schema","title":"RcsInputCountryCodesUsEnum","data":{"type":"string","const":"US","description":"Country of the company's tax registration for US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch."}},"components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"companyPhoneNumber":{"type":"string","description":"The registered phone number of the company. Not required for create, but required for launch.","minLength":1,"maxLength":13,"uniqueItems":false},"companyEmailAddress":{"type":"string","format":"email","maxLength":100,"uniqueItems":false},"brandName":{"type":"string","description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"brandIndustry":{"x-enumDescriptions":{"AGRICULTURE":"The brand operates within the agriculture sector.","COMMUNICATION":"The brand operates within the communication industry.","CONSTRUCTION":"The brand operates within the construction sector.","EDUCATION":"The brand operates within the education field.","ENERGY":"The brand operates within the energy and utilities sector.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","FINANCIAL":"The brand operates within the financial services sector.","GAMBLING":"The brand operates within the gambling or betting industry.","GOVERNMENT":"The brand is a government or public administration entity.","HEALTHCARE":"The brand operates within the healthcare and medical sector.","HOSPITALITY":"The brand operates within hospitality, tourism, or food services.","HUMAN_RESOURCES":"The brand operates within human resources and staffing services.","INSURANCE":"The brand operates within the insurance sector.","LEGAL":"The brand operates within legal services.","MANUFACTURING":"The brand operates within the manufacturing sector.","NON_GOVERNMENTAL_ORGANIZATION":"The brand is a non-governmental organization (NGO).","POLITICAL":"The brand is a political organization or campaign.","POSTAL":"The brand operates within postal, courier, or delivery services.","PROFESSIONAL":"The brand provides professional, scientific, or technical services.","REAL_ESTATE":"The brand operates within the real estate market.","RETAIL":"The brand operates within retail or wholesale commerce.","TECHNOLOGY":"The brand operates within the technology and software sector.","TRANSPORTATION":"The brand operates within transportation or logistics services."},"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum"}]},"addressLine":{"type":"string","description":"Street address line. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCity":{"type":"string","description":"City. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"addressPostalCode":{"type":"string","description":"Postal code. Not required for create, but required for launch.","minLength":1,"maxLength":10,"uniqueItems":false},"websiteUrl":{"type":"string","description":"Primary website URL. Not required for create, but required for launch.","format":"url","maxLength":100,"uniqueItems":false},"contactFirstName":{"type":"string","description":"First name of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"contactSurname":{"type":"string","description":"Surname of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"sampleMessages":{"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","minItems":1,"maxItems":5,"uniqueItems":false,"type":"array","items":{"type":"string","maxLength":1024,"minLength":20}},"messagesVolume":{"type":"number","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"embeddedLink":{"type":"boolean","description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"embeddedPhone":{"type":"boolean","description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"ageGatedContent":{"type":"boolean","description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false},"directLending":{"type":"boolean","description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false},"optInConfirmationMessage":{"type":"string","description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"helpMessage":{"type":"string","description":"Help message of the campaign. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"callToActionMessage":{"type":"string","description":"Call to action message of the campaign. Not required for create, but required for launch.","minLength":40,"maxLength":4096,"uniqueItems":false},"ownershipType":{"x-enumDescriptions":{"PUBLIC":"The brand is a publicly traded company."},"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireOwnershipTypePublicEnum"}]},"legalForm":{"x-enumDescriptions":{"CORPORATION":"The company is registered as a Corporation."},"description":"Legal form of the company for public ownership type. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsPublicUsQuestionnaireBrandLegalFormsEnum"}]},"taxIdCountry":{"x-enumDescriptions":{"US":"The country code for the United States of America."},"description":"Country of the company's tax registration for US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesUsEnum"}]},"taxId":{"type":"string","description":"Tax registration identifier associated with the provided legal company name for US taxIdCountry. Must follow format XX-XXXXXXX (example: 12-3456789). Not required for create, but required for launch.","minLength":1,"maxLength":25,"uniqueItems":false},"addressState":{"x-enumDescriptions":{"AK":"The State of Alaska.","AL":"The State of Alabama.","AR":"The State of Arkansas.","AS":"The US territory of American Samoa.","AZ":"The State of Arizona.","CA":"The State of California.","CO":"The State of Colorado.","CT":"The State of Connecticut.","DC":"The District of Columbia.","DE":"The State of Delaware.","FL":"The State of Florida.","GA":"The State of Georgia.","GU":"The US territory of Guam.","HI":"The State of Hawaii.","IA":"The State of Iowa.","ID":"The State of Idaho.","IL":"The State of Illinois.","IN":"The State of Indiana.","KS":"The State of Kansas.","KY":"The Commonwealth of Kentucky.","LA":"The State of Louisiana.","MA":"The Commonwealth of Massachusetts.","MD":"The State of Maryland.","ME":"The State of Maine.","MI":"The State of Michigan.","MN":"The State of Minnesota.","MO":"The State of Missouri.","MP":"The US Commonwealth of the Northern Mariana Islands.","MS":"The State of Mississippi.","MT":"The State of Montana.","NC":"The State of North Carolina.","ND":"The State of North Dakota.","NE":"The State of Nebraska.","NH":"The State of New Hampshire.","NJ":"The State of New Jersey.","NM":"The State of New Mexico.","NV":"The State of Nevada.","NY":"The State of New York.","OH":"The State of Ohio.","OK":"The State of Oklahoma.","OR":"The State of Oregon.","PA":"The Commonwealth of Pennsylvania.","PR":"The US territory of Puerto Rico.","RI":"The State of Rhode Island.","SC":"The State of South Carolina.","SD":"The State of South Dakota.","TN":"The State of Tennessee.","TX":"The State of Texas.","UT":"The State of Utah.","VA":"The Commonwealth of Virginia.","VI":"The US territory of the Virgin Islands.","VT":"The State of Vermont.","WA":"The State of Washington.","WI":"The State of Wisconsin.","WV":"The State of West Virginia.","WY":"The State of Wyoming."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State (US only). Validated when taxIdCountry=US and ignored for non-US taxIdCountry."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsStatesEnum"}]},"stockExchange":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary home country stock exchange abbreviation. Validated when ownershipType=PUBLIC."},"children":[]}]}]}],"minLength":1,"maxLength":10,"uniqueItems":false},"stockSymbol":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary home country stock symbol associated with stock exchange. Validated when ownershipType=PUBLIC."},"children":[]}]}]}],"minLength":1,"maxLength":6,"uniqueItems":false}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation schema for US brand campaign answers: taxIdCountry=US, ownershipType=PUBLIC."},"children":[]}]}]}],"required":["companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","ownershipType","legalForm","taxIdCountry","taxId","addressState","stockExchange","stockSymbol"]}},"components/schemas/RcsUsQuestionnaireOwnershipTypePrivateEnum":{"id":"components/schemas/RcsUsQuestionnaireOwnershipTypePrivateEnum","kind":"json-schema","title":"RcsUsQuestionnaireOwnershipTypePrivateEnum","data":{"type":"string","const":"PRIVATE","description":"Ownership type of the company. Not required for create, but required for launch."}},"components/schemas/RcsPrivateUsQuestionnaireBrandLegalFormsEnum":{"id":"components/schemas/RcsPrivateUsQuestionnaireBrandLegalFormsEnum","kind":"json-schema","title":"RcsPrivateUsQuestionnaireBrandLegalFormsEnum","data":{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"],"description":"Legal form of the company for private ownership type. Not required for create, but required for launch."}},"components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"companyPhoneNumber":{"type":"string","description":"The registered phone number of the company. Not required for create, but required for launch.","minLength":1,"maxLength":13,"uniqueItems":false},"companyEmailAddress":{"type":"string","format":"email","maxLength":100,"uniqueItems":false},"brandName":{"type":"string","description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"brandIndustry":{"x-enumDescriptions":{"AGRICULTURE":"The brand operates within the agriculture sector.","COMMUNICATION":"The brand operates within the communication industry.","CONSTRUCTION":"The brand operates within the construction sector.","EDUCATION":"The brand operates within the education field.","ENERGY":"The brand operates within the energy and utilities sector.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","FINANCIAL":"The brand operates within the financial services sector.","GAMBLING":"The brand operates within the gambling or betting industry.","GOVERNMENT":"The brand is a government or public administration entity.","HEALTHCARE":"The brand operates within the healthcare and medical sector.","HOSPITALITY":"The brand operates within hospitality, tourism, or food services.","HUMAN_RESOURCES":"The brand operates within human resources and staffing services.","INSURANCE":"The brand operates within the insurance sector.","LEGAL":"The brand operates within legal services.","MANUFACTURING":"The brand operates within the manufacturing sector.","NON_GOVERNMENTAL_ORGANIZATION":"The brand is a non-governmental organization (NGO).","POLITICAL":"The brand is a political organization or campaign.","POSTAL":"The brand operates within postal, courier, or delivery services.","PROFESSIONAL":"The brand provides professional, scientific, or technical services.","REAL_ESTATE":"The brand operates within the real estate market.","RETAIL":"The brand operates within retail or wholesale commerce.","TECHNOLOGY":"The brand operates within the technology and software sector.","TRANSPORTATION":"The brand operates within transportation or logistics services."},"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum"}]},"addressLine":{"type":"string","description":"Street address line. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCity":{"type":"string","description":"City. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"addressPostalCode":{"type":"string","description":"Postal code. Not required for create, but required for launch.","minLength":1,"maxLength":10,"uniqueItems":false},"websiteUrl":{"type":"string","description":"Primary website URL. Not required for create, but required for launch.","format":"url","maxLength":100,"uniqueItems":false},"contactFirstName":{"type":"string","description":"First name of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"contactSurname":{"type":"string","description":"Surname of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"sampleMessages":{"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","minItems":1,"maxItems":5,"uniqueItems":false,"type":"array","items":{"type":"string","maxLength":1024,"minLength":20}},"messagesVolume":{"type":"number","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"embeddedLink":{"type":"boolean","description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"embeddedPhone":{"type":"boolean","description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"ageGatedContent":{"type":"boolean","description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false},"directLending":{"type":"boolean","description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false},"optInConfirmationMessage":{"type":"string","description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"helpMessage":{"type":"string","description":"Help message of the campaign. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"callToActionMessage":{"type":"string","description":"Call to action message of the campaign. Not required for create, but required for launch.","minLength":40,"maxLength":4096,"uniqueItems":false},"ownershipType":{"x-enumDescriptions":{"PRIVATE":"The brand is a privately owned entity."},"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireOwnershipTypePrivateEnum"}]},"legalForm":{"x-enumDescriptions":{"CORPORATION":"The company is registered as a Corporation.","LIMITED_LIABILITY_COMPANY":"The company is registered as a Limited Liability Company (LLC).","PARTNERSHIP":"The company is registered as a Partnership.","S_CORPORATION":"The company is registered as an S Corporation."},"description":"Legal form of the company for private ownership type. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsPrivateUsQuestionnaireBrandLegalFormsEnum"}]},"taxIdCountry":{"x-enumDescriptions":{"US":"The country code for the United States of America."},"description":"Country of the company's tax registration for US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesUsEnum"}]},"taxId":{"type":"string","description":"Tax registration identifier associated with the provided legal company name for US taxIdCountry. Must follow format XX-XXXXXXX (example: 12-3456789). Not required for create, but required for launch.","minLength":1,"maxLength":25,"uniqueItems":false},"addressState":{"x-enumDescriptions":{"AK":"The State of Alaska.","AL":"The State of Alabama.","AR":"The State of Arkansas.","AS":"The US territory of American Samoa.","AZ":"The State of Arizona.","CA":"The State of California.","CO":"The State of Colorado.","CT":"The State of Connecticut.","DC":"The District of Columbia.","DE":"The State of Delaware.","FL":"The State of Florida.","GA":"The State of Georgia.","GU":"The US territory of Guam.","HI":"The State of Hawaii.","IA":"The State of Iowa.","ID":"The State of Idaho.","IL":"The State of Illinois.","IN":"The State of Indiana.","KS":"The State of Kansas.","KY":"The Commonwealth of Kentucky.","LA":"The State of Louisiana.","MA":"The Commonwealth of Massachusetts.","MD":"The State of Maryland.","ME":"The State of Maine.","MI":"The State of Michigan.","MN":"The State of Minnesota.","MO":"The State of Missouri.","MP":"The US Commonwealth of the Northern Mariana Islands.","MS":"The State of Mississippi.","MT":"The State of Montana.","NC":"The State of North Carolina.","ND":"The State of North Dakota.","NE":"The State of Nebraska.","NH":"The State of New Hampshire.","NJ":"The State of New Jersey.","NM":"The State of New Mexico.","NV":"The State of Nevada.","NY":"The State of New York.","OH":"The State of Ohio.","OK":"The State of Oklahoma.","OR":"The State of Oregon.","PA":"The Commonwealth of Pennsylvania.","PR":"The US territory of Puerto Rico.","RI":"The State of Rhode Island.","SC":"The State of South Carolina.","SD":"The State of South Dakota.","TN":"The State of Tennessee.","TX":"The State of Texas.","UT":"The State of Utah.","VA":"The Commonwealth of Virginia.","VI":"The US territory of the Virgin Islands.","VT":"The State of Vermont.","WA":"The State of Washington.","WI":"The State of Wisconsin.","WV":"The State of West Virginia.","WY":"The State of Wyoming."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State (US only). Validated when taxIdCountry=US and ignored for non-US taxIdCountry."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsStatesEnum"}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation schema for US brand campaign answers: taxIdCountry=US, ownershipType=PRIVATE."},"children":[]}]}]}],"required":["companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","ownershipType","legalForm","taxIdCountry","taxId","addressState"]}},"components/schemas/RcsInputCountryCodesNonUsEnum":{"id":"components/schemas/RcsInputCountryCodesNonUsEnum","kind":"json-schema","title":"RcsInputCountryCodesNonUsEnum","data":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Country of the company's tax registration for non-US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch."}},"components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"companyPhoneNumber":{"type":"string","description":"The registered phone number of the company. Not required for create, but required for launch.","minLength":1,"maxLength":13,"uniqueItems":false},"companyEmailAddress":{"type":"string","format":"email","maxLength":100,"uniqueItems":false},"brandName":{"type":"string","description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"brandIndustry":{"x-enumDescriptions":{"AGRICULTURE":"The brand operates within the agriculture sector.","COMMUNICATION":"The brand operates within the communication industry.","CONSTRUCTION":"The brand operates within the construction sector.","EDUCATION":"The brand operates within the education field.","ENERGY":"The brand operates within the energy and utilities sector.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","FINANCIAL":"The brand operates within the financial services sector.","GAMBLING":"The brand operates within the gambling or betting industry.","GOVERNMENT":"The brand is a government or public administration entity.","HEALTHCARE":"The brand operates within the healthcare and medical sector.","HOSPITALITY":"The brand operates within hospitality, tourism, or food services.","HUMAN_RESOURCES":"The brand operates within human resources and staffing services.","INSURANCE":"The brand operates within the insurance sector.","LEGAL":"The brand operates within legal services.","MANUFACTURING":"The brand operates within the manufacturing sector.","NON_GOVERNMENTAL_ORGANIZATION":"The brand is a non-governmental organization (NGO).","POLITICAL":"The brand is a political organization or campaign.","POSTAL":"The brand operates within postal, courier, or delivery services.","PROFESSIONAL":"The brand provides professional, scientific, or technical services.","REAL_ESTATE":"The brand operates within the real estate market.","RETAIL":"The brand operates within retail or wholesale commerce.","TECHNOLOGY":"The brand operates within the technology and software sector.","TRANSPORTATION":"The brand operates within transportation or logistics services."},"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum"}]},"addressLine":{"type":"string","description":"Street address line. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCity":{"type":"string","description":"City. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"addressPostalCode":{"type":"string","description":"Postal code. Not required for create, but required for launch.","minLength":1,"maxLength":10,"uniqueItems":false},"websiteUrl":{"type":"string","description":"Primary website URL. Not required for create, but required for launch.","format":"url","maxLength":100,"uniqueItems":false},"contactFirstName":{"type":"string","description":"First name of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"contactSurname":{"type":"string","description":"Surname of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"sampleMessages":{"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","minItems":1,"maxItems":5,"uniqueItems":false,"type":"array","items":{"type":"string","maxLength":1024,"minLength":20}},"messagesVolume":{"type":"number","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"embeddedLink":{"type":"boolean","description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"embeddedPhone":{"type":"boolean","description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"ageGatedContent":{"type":"boolean","description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false},"directLending":{"type":"boolean","description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false},"optInConfirmationMessage":{"type":"string","description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"helpMessage":{"type":"string","description":"Help message of the campaign. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"callToActionMessage":{"type":"string","description":"Call to action message of the campaign. Not required for create, but required for launch.","minLength":40,"maxLength":4096,"uniqueItems":false},"ownershipType":{"x-enumDescriptions":{"PUBLIC":"The brand is a publicly traded company."},"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireOwnershipTypePublicEnum"}]},"legalForm":{"x-enumDescriptions":{"CORPORATION":"The company is registered as a Corporation."},"description":"Legal form of the company for public ownership type. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsPublicUsQuestionnaireBrandLegalFormsEnum"}]},"taxIdCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country of the company's tax registration for non-US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesNonUsEnum"}]},"taxId":{"type":"string","description":"Tax registration identifier associated with the provided legal company name for non-US taxIdCountry. Validated as a generic string up to 25 characters. Not required for create, but required for launch.","minLength":1,"maxLength":25,"uniqueItems":false},"stockExchange":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary home country stock exchange abbreviation. Validated when ownershipType=PUBLIC."},"children":[]}]}]}],"minLength":1,"maxLength":10,"uniqueItems":false},"stockSymbol":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary home country stock symbol associated with stock exchange. Validated when ownershipType=PUBLIC."},"children":[]}]}]}],"minLength":1,"maxLength":6,"uniqueItems":false}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation schema for US brand campaign answers: taxIdCountry!=US, ownershipType=PUBLIC."},"children":[]}]}]}],"required":["companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","ownershipType","legalForm","taxIdCountry","taxId","stockExchange","stockSymbol"]}},"components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","description":"The registered legal name of the company. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"companyPhoneNumber":{"type":"string","description":"The registered phone number of the company. Not required for create, but required for launch.","minLength":1,"maxLength":13,"uniqueItems":false},"companyEmailAddress":{"type":"string","format":"email","maxLength":100,"uniqueItems":false},"brandName":{"type":"string","description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"brandIndustry":{"x-enumDescriptions":{"AGRICULTURE":"The brand operates within the agriculture sector.","COMMUNICATION":"The brand operates within the communication industry.","CONSTRUCTION":"The brand operates within the construction sector.","EDUCATION":"The brand operates within the education field.","ENERGY":"The brand operates within the energy and utilities sector.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","FINANCIAL":"The brand operates within the financial services sector.","GAMBLING":"The brand operates within the gambling or betting industry.","GOVERNMENT":"The brand is a government or public administration entity.","HEALTHCARE":"The brand operates within the healthcare and medical sector.","HOSPITALITY":"The brand operates within hospitality, tourism, or food services.","HUMAN_RESOURCES":"The brand operates within human resources and staffing services.","INSURANCE":"The brand operates within the insurance sector.","LEGAL":"The brand operates within legal services.","MANUFACTURING":"The brand operates within the manufacturing sector.","NON_GOVERNMENTAL_ORGANIZATION":"The brand is a non-governmental organization (NGO).","POLITICAL":"The brand is a political organization or campaign.","POSTAL":"The brand operates within postal, courier, or delivery services.","PROFESSIONAL":"The brand provides professional, scientific, or technical services.","REAL_ESTATE":"The brand operates within the real estate market.","RETAIL":"The brand operates within retail or wholesale commerce.","TECHNOLOGY":"The brand operates within the technology and software sector.","TRANSPORTATION":"The brand operates within transportation or logistics services."},"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum"}]},"addressLine":{"type":"string","description":"Street address line. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCity":{"type":"string","description":"City. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"addressCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"addressPostalCode":{"type":"string","description":"Postal code. Not required for create, but required for launch.","minLength":1,"maxLength":10,"uniqueItems":false},"websiteUrl":{"type":"string","description":"Primary website URL. Not required for create, but required for launch.","format":"url","maxLength":100,"uniqueItems":false},"contactFirstName":{"type":"string","description":"First name of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"contactSurname":{"type":"string","description":"Surname of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false},"sampleMessages":{"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","minItems":1,"maxItems":5,"uniqueItems":false,"type":"array","items":{"type":"string","maxLength":1024,"minLength":20}},"messagesVolume":{"type":"number","description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false},"embeddedLink":{"type":"boolean","description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"embeddedPhone":{"type":"boolean","description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false},"ageGatedContent":{"type":"boolean","description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false},"directLending":{"type":"boolean","description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false},"optInConfirmationMessage":{"type":"string","description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"helpMessage":{"type":"string","description":"Help message of the campaign. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false},"callToActionMessage":{"type":"string","description":"Call to action message of the campaign. Not required for create, but required for launch.","minLength":40,"maxLength":4096,"uniqueItems":false},"ownershipType":{"x-enumDescriptions":{"PRIVATE":"The brand is a privately owned entity."},"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUsQuestionnaireOwnershipTypePrivateEnum"}]},"legalForm":{"x-enumDescriptions":{"CORPORATION":"The company is registered as a Corporation.","LIMITED_LIABILITY_COMPANY":"The company is registered as a Limited Liability Company (LLC).","PARTNERSHIP":"The company is registered as a Partnership.","S_CORPORATION":"The company is registered as an S Corporation."},"description":"Legal form of the company for private ownership type. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsPrivateUsQuestionnaireBrandLegalFormsEnum"}]},"taxIdCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country of the company's tax registration for non-US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputCountryCodesNonUsEnum"}]},"taxId":{"type":"string","description":"Tax registration identifier associated with the provided legal company name for non-US taxIdCountry. Validated as a generic string up to 25 characters. Not required for create, but required for launch.","minLength":1,"maxLength":25,"uniqueItems":false}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation schema for US brand campaign answers: taxIdCountry!=US, ownershipType=PRIVATE."},"children":[]}]}]}],"required":["companyLegalName","companyPhoneNumber","companyEmailAddress","brandName","brandIndustry","addressLine","addressCity","addressCountry","addressPostalCode","websiteUrl","contactFirstName","contactSurname","sampleMessages","messagesVolume","embeddedLink","embeddedPhone","ageGatedContent","directLending","optInConfirmationMessage","helpMessage","callToActionMessage","ownershipType","legalForm","taxIdCountry","taxId"]}},"components/schemas/RcsSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"type":"string","minLength":0,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false},"ein":{"type":"string","pattern":"^\\d{2}-\\d{7}$","description":"For US companies: Employer Identification Number (EIN). Must be a nine-digit number assigned by the IRS, following format: XX-XXXXXXX.","uniqueItems":false},"brandIndustry":{"type":"string","minLength":0,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false},"fullCompanyAddress":{"type":"string","minLength":0,"description":"Full company address.","uniqueItems":false},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"smsCampaign":{"type":"string","minLength":0,"description":"US SMS campaign used as fallback.","uniqueItems":false},"messagesVolume":{"type":"string","minLength":0,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false}},"description":"SenderDetailsQuestionnaireUSAnswersInputDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto instead."}},"components/schemas/RcsSenderDetailsQuestionnaireUSInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireUSInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireUSInputDto","data":{"type":"object","properties":{"answers":{"oneOf":[{"$ref":"#/components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto"},{"$ref":"#/components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto"},{"$ref":"#/components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto"},{"$ref":"#/components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto"},{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSAnswersInputDto"}],"description":"Launch answers specific for US.","uniqueItems":false}},"required":["answers"]}},"components/schemas/RcsSenderDetailsQuestionnaireInputDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireInputDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireInputDto","data":{"type":"object","properties":{"general":{"description":"General launch questions","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralInputDto"}]},"verification":{"description":"Verification questions.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationInputDto"}]},"gb":{"description":"Launch questions specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBInputDto"}]},"fr":{"description":"Launch questions specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRInputDto"}]},"us":{"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSInputDto"}]}}}},"components/schemas/RcsSenderDetailsInputDto":{"id":"components/schemas/RcsSenderDetailsInputDto","kind":"json-schema","title":"RcsSenderDetailsInputDto","data":{"type":"object","properties":{"brand":{"description":"Brand information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsBrandInputDto"}]},"testNumbers":{"maxItems":200,"uniqueItems":true,"description":"Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.","type":"array","items":{"type":"string","format":"e.164 phone number"}},"countries":{"type":"array","x-enumDescriptions":{"AT":"The country code for Austria.","BE":"The country code for Belgium.","BR":"The country code for Brazil.","CA":"The country code for Canada.","CZ":"The country code for the Czech Republic.","DK":"The country code for Denmark.","FI":"The country code for Finland.","FR":"The country code for France.","DE":"The country code for Germany.","GR":"The country code for Greece.","HU":"The country code for Hungary.","IT":"The country code for Italy.","LT":"The country code for Lithuania.","MX":"The country code for Mexico.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","PE":"The country code for Peru.","PL":"The country code for Poland.","PT":"The country code for Portugal.","SG":"The country code for Singapore.","SK":"The country code for Slovakia.","ES":"The country code for Spain.","SE":"The country code for Sweden.","US":"The country code for the United States of America.","GB":"The country code for the United Kingdom of Great Britain."},"minItems":1,"uniqueItems":true,"description":"List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in.","items":{"$ref":"#/components/schemas/RcsInputRcsCountryCodesEnum"}},"questionnaire":{"description":"\n  Launch questionnaire.\n\n  The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n  ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireInputDto"}]}}}},"components/schemas/RcsSenderInputDto":{"id":"components/schemas/RcsSenderInputDto","kind":"json-schema","title":"RcsSenderInputDto","data":{"type":"object","properties":{"region":{"x-enumDescriptions":{"BR":"Specifies that the sender operations should be initialized within the Brazil region.","EU":"Specifies that the sender operations should be initialized within the Europe region.","US":"Specifies that the sender operations should be initialized within the United States region."},"description":"Region sender is provisioned in.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputSenderRegionsEnum"}]},"billingCategory":{"x-enumDescriptions":{"CONVERSATIONAL":"Selects the session-based billing model dedicated to continuous multi-turn interactive conversations.","NON_CONVERSATIONAL":"Selects the transactional billing model dedicated to isolated alerts or one-way system messages.","BASIC_MESSAGE":"Selects the legacy, text-only communication billing category.","CONVERSATIONAL_LEGACY":"Selects the legacy conversational data tier layout for backwards compatibility layers.","SINGLE_MESSAGE":"Selects the standalone billing layer dedicated to individual discrete message transmissions."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  billing framework distinguishes between two primary categories: non-conversational and conversational."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents.  Deprecated value, use CONVERSATIONAL instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead."},"children":[]}]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputSenderBillingCategoriesEnum"}]},"useCase":{"x-enumDescriptions":{"MULTIUSE":"Configures the sender for multiple distinct types of message flows.","OTP":"Configures the sender exclusively for one-time passwords and secure tokens.","PROMOTIONAL":"Configures the sender for marketing, offers, and promotional broadcasts.","TRANSACTIONAL":"Configures the sender for critical, non-marketing customer alerts and account updates."},"description":"Use case.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsInputSenderUseCasesEnum"}]},"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsInputDto"}]}},"required":["region","billingCategory","useCase"]}},"components/schemas/RcsUpdateSenderDetailsBrandInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsBrandInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsBrandInputDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":0,"maxLength":40,"description":"Brand name.","uniqueItems":false},"emails":{"minItems":1,"maxItems":3,"description":"Contact emails. If null the value will be deleted. Field 'address' must have unique values across items.","uniqueItems":true,"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/RcsEmailInputDto"}},{"type":"null"}]},"phones":{"minItems":1,"maxItems":3,"description":"Contact phone numbers. If null the value will be deleted. Field 'number' must have unique values across items.","uniqueItems":true,"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/RcsPhoneInputDto"}},{"type":"null"}]},"websites":{"minItems":1,"maxItems":3,"description":"Contact websites. If null the value will be deleted. Field 'url' must have unique values across items.","uniqueItems":true,"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/RcsWebsiteInputDto"}},{"type":"null"}]},"color":{"type":"string","format":"hex","description":"Brand color (HEX code).","uniqueItems":false},"description":{"type":"string","minLength":0,"maxLength":100,"description":"Brand description.","uniqueItems":false},"bannerUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand banner url."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 200KB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact image dimensions: 1440 x 448 px."},"children":[]}]}]}]}],"uniqueItems":false},"logoUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand logo url."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported mime types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum file size: 50KB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exact image dimensions: 224 x 224 px."},"children":[]}]}]}]}],"uniqueItems":false},"privacyPolicyUrl":{"type":"string","format":"url","description":"Privacy Policy URL.","uniqueItems":false},"termsOfServiceUrl":{"type":"string","format":"url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terms & Conditions URL."},"children":[]}]}]}],"uniqueItems":false}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto","data":{"type":"object","properties":{"ignore":{"minLength":1,"description":"Ignore given string on launch, e.g. custom delimiter. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto","data":{"type":"object","properties":{"optInDescription":{"minLength":1,"description":"How you obtain opt-in to message users. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"optInDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"triggerDescription":{"minLength":1,"description":"Actions that triggers messages to users. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"triggerDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"interactionsDescription":{"minLength":1,"description":"Interactions with users. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"interactionsDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"optOutDescription":{"minLength":1,"description":"The message the sender sends when a user opts out. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"optOutDescriptionMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"videoUris":{"format":"url","minItems":1,"description":"Publicly available URIs for videos of the sender, for review purposes only. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"screenshotUris":{"format":"url","minItems":1,"description":"Publicly available URIs for screenshots of the sender, for review purposes only. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireGeneralInputDto","data":{"type":"object","properties":{"answers":{"description":"Launch answers","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto","data":{"type":"object","properties":{"companyName":{"minLength":1,"maxLength":100,"description":"Company name of the brand partner. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"contactName":{"minLength":1,"maxLength":100,"description":"Name of the contact person of the brand partner. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"contactEmailAddress":{"format":"email","maxLength":100,"description":"Email of the contact person of the brand partner. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto","data":{"type":"object","properties":{"name":{"minLength":1,"description":"Name of verification contact. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"email":{"format":"email","maxLength":100,"description":"Email of verification contact. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"title":{"minLength":1,"maxLength":100,"description":"Title of verification contact. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"website":{"format":"url","description":"Website of verification contact. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"phone":{"pattern":"^(?:\\+|00)\\d{6,15}$","minLength":1,"maxLength":17,"description":"Phone number of verification contact in E.164 format. Required for launch when the sender uses the US country questionnaire version v2, otherwise optional. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"partner":{"description":"Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto"},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireVerificationInputDto","data":{"type":"object","properties":{"answers":{"description":"Verification answers. Senders using the US country questionnaire version v2 must also provide phone on launch, all other senders only provide name, email and website.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireGBAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireGBAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireGBAnswersInputDto","data":{"type":"object","properties":{"brandIndustry":{"minLength":1,"description":"Sector or industry of business. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"companyLegalName":{"minLength":1,"description":"The registered legal name of the company. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"companyRegistrationNumber":{"minLength":1,"description":"The company registration number.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"fullCompanyAddress":{"minLength":1,"description":"Full company address. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"messagesVolume":{"minLength":1,"description":"Messages volume. Not required for create, but required for launch. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"messagesFrequency":{"minLength":1,"description":"Messages frequency. If null the value will be deleted.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"campaignLength":{"minLength":1,"description":"Length of campaign. If null the value will be deleted.","deprecated":true,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireGBInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireGBInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireGBInputDto","data":{"type":"object","properties":{"answers":{"description":"Launch answers specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGBAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireFRAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireFRAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireFRAnswersInputDto","data":{"type":"object","properties":{"fullCompanyAddress":{"minLength":1,"description":"Full company address.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"siren":{"pattern":"^\\d+$","minLength":9,"maxLength":9,"description":"Company directory identification system number.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireFRInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireFRInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireFRInputDto","data":{"type":"object","properties":{"answers":{"description":"Launch answers specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireFRAnswersInputDto"}]}},"required":["answers"]}},"components/schemas/RcsBrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsBrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsBrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"ownershipType":{"x-enumDescriptions":{"PRIVATE":"The brand is a privately owned entity.","PUBLIC":"The brand is a publicly traded company."},"description":"Ownership type of the company. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string","enum":["PRIVATE","PUBLIC"]},{"type":"null"},{"$ref":"#/components/schemas/RcsUsQuestionnaireOwnershipTypeEnum"}]},"companyLegalName":{"description":"The registered legal name of the company. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"companyPhoneNumber":{"description":"The registered phone number of the company. Not required for create, but required for launch.","minLength":1,"maxLength":13,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"companyEmailAddress":{"format":"email","maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"brandName":{"description":"Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"brandIndustry":{"x-enumDescriptions":{"AGRICULTURE":"The brand operates within the agriculture sector.","COMMUNICATION":"The brand operates within the communication industry.","CONSTRUCTION":"The brand operates within the construction sector.","EDUCATION":"The brand operates within the education field.","ENERGY":"The brand operates within the energy and utilities sector.","ENTERTAINMENT":"The brand operates within the entertainment and media industry.","FINANCIAL":"The brand operates within the financial services sector.","GAMBLING":"The brand operates within the gambling or betting industry.","GOVERNMENT":"The brand is a government or public administration entity.","HEALTHCARE":"The brand operates within the healthcare and medical sector.","HOSPITALITY":"The brand operates within hospitality, tourism, or food services.","HUMAN_RESOURCES":"The brand operates within human resources and staffing services.","INSURANCE":"The brand operates within the insurance sector.","LEGAL":"The brand operates within legal services.","MANUFACTURING":"The brand operates within the manufacturing sector.","NON_GOVERNMENTAL_ORGANIZATION":"The brand is a non-governmental organization (NGO).","POLITICAL":"The brand is a political organization or campaign.","POSTAL":"The brand operates within postal, courier, or delivery services.","PROFESSIONAL":"The brand provides professional, scientific, or technical services.","REAL_ESTATE":"The brand operates within the real estate market.","RETAIL":"The brand operates within retail or wholesale commerce.","TECHNOLOGY":"The brand operates within the technology and software sector.","TRANSPORTATION":"The brand operates within transportation or logistics services."},"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string","enum":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},{"type":"null"},{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum"}]},"legalForm":{"x-enumDescriptions":{"CORPORATION":"The company is registered as a Corporation.","LIMITED_LIABILITY_COMPANY":"The company is registered as a Limited Liability Company (LLC).","PARTNERSHIP":"The company is registered as a Partnership.","S_CORPORATION":"The company is registered as an S Corporation."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal form of the company. For ownershipType=PUBLIC only CORPORATION is allowed. For ownershipType=PRIVATE allowed values are CORPORATION, LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch."},"children":[]}]}]}],"uniqueItems":false,"oneOf":[{"type":"string","enum":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},{"type":"null"},{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandLegalFormsEnum"}]},"taxIdCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country of the company's tax registration. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},{"type":"null"},{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"taxId":{"description":"Tax registration identifier associated with the provided legal company name. For US taxIdCountry it must follow format XX-XXXXXXX (example: 12-3456789). For non-US taxIdCountry it is validated as a generic string up to 25 characters. Not required for create, but required for launch.","minLength":1,"maxLength":25,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"addressLine":{"description":"Street address line. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"addressCity":{"description":"City. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"addressCountry":{"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe."},"description":"Country. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},{"type":"null"},{"$ref":"#/components/schemas/RcsInputCountryCodesEnum"}]},"addressState":{"x-enumDescriptions":{"AK":"The State of Alaska.","AL":"The State of Alabama.","AR":"The State of Arkansas.","AS":"The US territory of American Samoa.","AZ":"The State of Arizona.","CA":"The State of California.","CO":"The State of Colorado.","CT":"The State of Connecticut.","DC":"The District of Columbia.","DE":"The State of Delaware.","FL":"The State of Florida.","GA":"The State of Georgia.","GU":"The US territory of Guam.","HI":"The State of Hawaii.","IA":"The State of Iowa.","ID":"The State of Idaho.","IL":"The State of Illinois.","IN":"The State of Indiana.","KS":"The State of Kansas.","KY":"The Commonwealth of Kentucky.","LA":"The State of Louisiana.","MA":"The Commonwealth of Massachusetts.","MD":"The State of Maryland.","ME":"The State of Maine.","MI":"The State of Michigan.","MN":"The State of Minnesota.","MO":"The State of Missouri.","MP":"The US Commonwealth of the Northern Mariana Islands.","MS":"The State of Mississippi.","MT":"The State of Montana.","NC":"The State of North Carolina.","ND":"The State of North Dakota.","NE":"The State of Nebraska.","NH":"The State of New Hampshire.","NJ":"The State of New Jersey.","NM":"The State of New Mexico.","NV":"The State of Nevada.","NY":"The State of New York.","OH":"The State of Ohio.","OK":"The State of Oklahoma.","OR":"The State of Oregon.","PA":"The Commonwealth of Pennsylvania.","PR":"The US territory of Puerto Rico.","RI":"The State of Rhode Island.","SC":"The State of South Carolina.","SD":"The State of South Dakota.","TN":"The State of Tennessee.","TX":"The State of Texas.","UT":"The State of Utah.","VA":"The Commonwealth of Virginia.","VI":"The US territory of the Virgin Islands.","VT":"The State of Vermont.","WA":"The State of Washington.","WI":"The State of Wisconsin.","WV":"The State of West Virginia.","WY":"The State of Wyoming."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State (US only). Validated when taxIdCountry=US and ignored for non-US taxIdCountry."},"children":[]}]}]}],"uniqueItems":false,"oneOf":[{"type":"string","enum":["AK","AL","AR","AS","AZ","CA","CO","CT","DC","DE","FL","GA","GU","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MI","MN","MO","MP","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VA","VI","VT","WA","WI","WV","WY"]},{"type":"null"},{"$ref":"#/components/schemas/RcsUsStatesEnum"}]},"addressPostalCode":{"description":"Postal code. Not required for create, but required for launch.","minLength":1,"maxLength":10,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"websiteUrl":{"description":"Primary website URL. Not required for create, but required for launch.","format":"url","maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"contactFirstName":{"description":"First name of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"contactSurname":{"description":"Surname of the responsible contact person. Not required for create, but required for launch.","minLength":1,"maxLength":100,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"stockExchange":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary home country stock exchange abbreviation. Validated when ownershipType=PUBLIC."},"children":[]}]}]}],"minLength":1,"maxLength":10,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"stockSymbol":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary home country stock symbol associated with stock exchange. Validated when ownershipType=PUBLIC."},"children":[]}]}]}],"minLength":1,"maxLength":6,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"sampleMessages":{"description":"Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"minItems":1,"maxItems":5,"uniqueItems":false,"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"messagesVolume":{"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"number"},{"type":"null"}]},"embeddedLink":{"description":"Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"boolean"},{"type":"null"}]},"embeddedPhone":{"description":"Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"boolean"},{"type":"null"}]},"ageGatedContent":{"description":"Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"boolean"},{"type":"null"}]},"directLending":{"description":"Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"boolean"},{"type":"null"}]},"optInConfirmationMessage":{"description":"Opt-in confirmation message sent to users. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"helpMessage":{"description":"Help message of the campaign. Not required for create, but required for launch.","minLength":20,"maxLength":1024,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"callToActionMessage":{"description":"Call to action message of the campaign. Not required for create, but required for launch.","minLength":40,"maxLength":4096,"uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}}}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto","data":{"type":"object","properties":{"companyLegalName":{"minLength":0,"description":"The registered legal name of the company. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"ein":{"pattern":"^\\d{2}-\\d{7}$","description":"For US companies: Employer Identification Number (EIN). Must be a nine-digit number assigned by the IRS, following format: XX-XXXXXXX.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"brandIndustry":{"minLength":0,"description":"Sector or industry of business. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"fullCompanyAddress":{"minLength":0,"description":"Full company address.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"fullCompanyAddressMetadata":{"description":"Metadata for specified answer.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto"}]},"smsCampaign":{"minLength":0,"description":"US SMS campaign used as fallback.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]},"messagesVolume":{"minLength":0,"description":"Messages volume. Not required for create, but required for launch.","uniqueItems":false,"oneOf":[{"type":"string"},{"type":"null"}]}},"description":"UpdateSenderDetailsQuestionnaireUSAnswersInputDto is deprecated and will be removed in future versions. Please use BrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto instead."}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireUSInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireUSInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireUSInputDto","data":{"type":"object","properties":{"answers":{"oneOf":[{"$ref":"#/components/schemas/RcsBrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto"},{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto"}],"description":"Launch answers specific for US.","uniqueItems":false}},"required":["answers"]}},"components/schemas/RcsUpdateSenderDetailsQuestionnaireInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsQuestionnaireInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsQuestionnaireInputDto","data":{"type":"object","properties":{"general":{"description":"General launch questions","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralInputDto"}]},"verification":{"description":"Verification questions.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationInputDto"}]},"gb":{"description":"Launch questions specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGBInputDto"}]},"fr":{"description":"Launch questions specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireFRInputDto"}]},"us":{"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireUSInputDto"}]}}}},"components/schemas/RcsUpdateSenderDetailsInputDto":{"id":"components/schemas/RcsUpdateSenderDetailsInputDto","kind":"json-schema","title":"RcsUpdateSenderDetailsInputDto","data":{"type":"object","properties":{"brand":{"description":"Brand information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsBrandInputDto"}]},"testNumbers":{"format":"e.164 phone number","maxItems":200,"uniqueItems":true,"description":"Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests. If null the value will be deleted.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"countries":{"x-enumDescriptions":{"AT":"The country code for Austria.","BE":"The country code for Belgium.","BR":"The country code for Brazil.","CA":"The country code for Canada.","CZ":"The country code for the Czech Republic.","DK":"The country code for Denmark.","FI":"The country code for Finland.","FR":"The country code for France.","DE":"The country code for Germany.","GR":"The country code for Greece.","HU":"The country code for Hungary.","IT":"The country code for Italy.","LT":"The country code for Lithuania.","MX":"The country code for Mexico.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","PE":"The country code for Peru.","PL":"The country code for Poland.","PT":"The country code for Portugal.","SG":"The country code for Singapore.","SK":"The country code for Slovakia.","ES":"The country code for Spain.","SE":"The country code for Sweden.","US":"The country code for the United States of America.","GB":"The country code for the United Kingdom of Great Britain."},"minItems":1,"uniqueItems":true,"description":"List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in. If null the value will be deleted.","oneOf":[{"type":"array","items":{"type":"string","enum":["AT","BE","BR","CA","CZ","DK","FI","FR","DE","GR","HU","IT","LT","MX","NL","NO","PE","PL","PT","SG","SK","ES","SE","US","GB"]}},{"type":"null"},{"$ref":"#/components/schemas/RcsInputRcsCountryCodesEnum"}]},"questionnaire":{"description":"\n  Launch questionnaire.\n\n  The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n  ","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsQuestionnaireInputDto"}]}}}},"components/schemas/RcsUpdateSenderInputDto":{"id":"components/schemas/RcsUpdateSenderInputDto","kind":"json-schema","title":"RcsUpdateSenderInputDto","data":{"type":"object","properties":{"details":{"description":"Sender details and information.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsUpdateSenderDetailsInputDto"}]}},"required":["details"]}},"components/schemas/RcsUsQuestionnaireVersionsEnum":{"id":"components/schemas/RcsUsQuestionnaireVersionsEnum","kind":"json-schema","title":"RcsUsQuestionnaireVersionsEnum","data":{"type":"string","enum":["v1","v2"]}},"components/schemas/RcsSenderNotificationTypeEnum":{"id":"components/schemas/RcsSenderNotificationTypeEnum","kind":"json-schema","title":"RcsSenderNotificationTypeEnum","data":{"type":"string","enum":["ACTIVE","COMMENT_ADDED","CREATED","DELETED","EDITED","INACTIVE","TEST"]}},"components/schemas/RcsSenderNotificationDto":{"id":"components/schemas/RcsSenderNotificationDto","kind":"json-schema","title":"RcsSenderNotificationDto","data":{"type":"object","properties":{"type":{"x-enumDescriptions":{"ACTIVE":"The notification configuration is active and enabled.","COMMENT_ADDED":"A new comment has been added to the notification trail.","CREATED":"The notification configuration has been successfully created.","DELETED":"The notification configuration has been deleted.","EDITED":"The notification configuration has been edited or updated.","INACTIVE":"The notification configuration is inactive or disabled.","TEST":"This is an isolated test or sandbox notification."},"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderNotificationTypeEnum"}]},"created":{"type":"string","uniqueItems":false},"author":{"type":"string","uniqueItems":false},"comment":{"type":"string","uniqueItems":false}},"required":["type"]}},"components/schemas/RcsSenderNotificationListDto":{"id":"components/schemas/RcsSenderNotificationListDto","kind":"json-schema","title":"RcsSenderNotificationListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/RcsSenderNotificationDto"},"uniqueItems":false}},"required":["totalSize","pageSize","notifications"]}},"components/schemas/RcsTestNumberCapabilitiesFeaturesEnum":{"id":"components/schemas/RcsTestNumberCapabilitiesFeaturesEnum","kind":"json-schema","title":"RcsTestNumberCapabilitiesFeaturesEnum","data":{"type":"string","enum":["ACTION_COMPOSE","ACTION_CREATE_CALENDAR_EVENT","ACTION_DIAL","ACTION_OPEN_URL","ACTION_OPEN_URL_IN_WEBVIEW","ACTION_SHARE_LOCATION","ACTION_VIEW_LOCATION","REVOCATION","RICHCARD_CAROUSEL","RICHCARD_STANDALONE","FEATURE_UNSPECIFIED","UNRECOGNIZED"],"description":"List of RBM features that this device supports."}},"components/schemas/RcsTestNumberCapabilitiesDto":{"id":"components/schemas/RcsTestNumberCapabilitiesDto","kind":"json-schema","title":"RcsTestNumberCapabilitiesDto","data":{"type":"object","properties":{"features":{"type":"array","x-enumDescriptions":{"ACTION_COMPOSE":"Indicates capability to handle client-side text or message composition triggers.","ACTION_CREATE_CALENDAR_EVENT":"Indicates capability to inject localized calendar entry payloads directly into the host device calendar.","ACTION_DIAL":"Indicates capability to execute native phone application routing and dialer triggers.","ACTION_OPEN_URL":"Indicates capability to route out of the messaging application and open hyperlinks inside the native mobile browser.","ACTION_OPEN_URL_IN_WEBVIEW":"Indicates capability to render deep links securely within an internal sandboxed application webview.","ACTION_SHARE_LOCATION":"Indicates capability to fetch and transmission coordinate attributes via native geolocational workflows.","ACTION_VIEW_LOCATION":"Indicates capability to map coordinates and launch map interfaces natively on the device UI.","REVOCATION":"Indicates capability to execute message deletion or recall commands on the target recipient device.","RICHCARD_CAROUSEL":"Indicates capability to display interactive multi-card rich layouts with horizontal scrolling loops.","RICHCARD_STANDALONE":"Indicates capability to process standalone single-frame rich multimedia cards containing active chips.","FEATURE_UNSPECIFIED":"The structural feature and interface capability profile remains unspecified.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"List of RBM features that this device supports.","uniqueItems":false,"items":{"$ref":"#/components/schemas/RcsTestNumberCapabilitiesFeaturesEnum"}}},"required":["features"]}},"components/schemas/RcsTestNumbersDto":{"id":"components/schemas/RcsTestNumbersDto","kind":"json-schema","title":"RcsTestNumbersDto","data":{"type":"object","properties":{"testNumbers":{"type":"array","items":{"$ref":"#/components/schemas/RcsTestNumberStateDto"},"description":"Test numbers states.","uniqueItems":false}},"required":["testNumbers"]}},"components/schemas/RcsTestNumbersInputDto":{"id":"components/schemas/RcsTestNumbersInputDto","kind":"json-schema","title":"RcsTestNumbersInputDto","data":{"type":"object","properties":{"testNumbers":{"maxItems":200,"uniqueItems":true,"description":"Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.","type":"array","items":{"type":"string","format":"e.164 phone number"}}},"required":["testNumbers"]}},"components/schemas/RcsSenderDetailsQuestionnaireGeneralBaseDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGeneralBaseDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGeneralBaseDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralQuestionsDto"}]}},"required":["questions"]}},"components/schemas/RcsSenderDetailsQuestionnaireVerificationBaseDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireVerificationBaseDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireVerificationBaseDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Verification questions.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationQuestionsDto"}]}},"required":["questions"]}},"components/schemas/RcsSenderDetailsQuestionnaireGBBaseDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireGBBaseDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireGBBaseDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBQuestionsDto"}]}},"required":["questions"]}},"components/schemas/RcsSenderDetailsQuestionnaireFRBaseDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireFRBaseDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireFRBaseDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRQuestionsDto"}]}},"required":["questions"]}},"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSBaseDto":{"id":"components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSBaseDto","kind":"json-schema","title":"RcsBrandCampaignSenderDetailsQuestionnaireUSBaseDto","data":{"type":"object","properties":{"questions":{"oneOf":[{"$ref":"#/components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"},{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto"}],"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false}},"required":["questions"]}},"components/schemas/RcsSenderDetailsQuestionnaireUSBaseDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireUSBaseDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireUSBaseDto","data":{"type":"object","properties":{"questions":{"readOnly":true,"description":"Launch questions specific for US.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSQuestionsDto"}]}},"description":"SenderDetailsQuestionnaireUSBaseDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSBaseDto instead.","required":["questions"]}},"components/schemas/RcsSenderDetailsQuestionnaireBaseDto":{"id":"components/schemas/RcsSenderDetailsQuestionnaireBaseDto","kind":"json-schema","title":"RcsSenderDetailsQuestionnaireBaseDto","data":{"type":"object","properties":{"general":{"description":"General launch questions","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGeneralBaseDto"}]},"verification":{"description":"Verification questions.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireVerificationBaseDto"}]},"gb":{"description":"Launch questions specific for UK.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireGBBaseDto"}]},"fr":{"description":"Launch questions specific for France.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireFRBaseDto"}]},"us":{"oneOf":[{"$ref":"#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSBaseDto"},{"$ref":"#/components/schemas/RcsSenderDetailsQuestionnaireUSBaseDto"}],"description":"Launch questions specific for US.","uniqueItems":false}},"required":["general","verification"]}},"components/schemas/RcsUsQuestionnaireBrandCampaignVersionsEnum":{"id":"components/schemas/RcsUsQuestionnaireBrandCampaignVersionsEnum","kind":"json-schema","title":"RcsUsQuestionnaireBrandCampaignVersionsEnum","data":{"type":"string","enum":["NON_US_PRIVATE","NON_US_PUBLIC","US_PRIVATE","US_PUBLIC"]}},"components/schemas/SmsPapiErrorDto":{"id":"components/schemas/SmsPapiErrorDto","kind":"json-schema","title":"SmsPapiErrorDto","data":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error.","uniqueItems":false},"message":{"type":"string","description":"Human-readable error message.","uniqueItems":false},"resolution":{"type":"string","description":"Suggested resolution for the error.","uniqueItems":false},"additionalInformation":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string"}}]},"description":"Additional context about the error.","uniqueItems":false}},"required":["errorCode","message","resolution"]}},"components/schemas/SmsProvisioningStatesEnum":{"id":"components/schemas/SmsProvisioningStatesEnum","kind":"json-schema","title":"SmsProvisioningStatesEnum","data":{"type":"string","enum":["ACTIVE","BLOCKED","DELETED","DEPROVISIONING","DEPROVISIONING_FAILED","FAILED_ADD","FAILED_BLOCK","FAILED_DELETE","FAILED_UNBLOCK","FAILED_UPDATE","IN_PROGRESS_ADD","IN_PROGRESS_BLOCK","IN_PROGRESS_DELETE","IN_PROGRESS_UNBLOCK","IN_PROGRESS_UPDATE","PENDING_ADD","PENDING_BLOCK","PENDING_DELETE","PENDING_UNBLOCK","PENDING_UPDATE","PROVISIONING","PROVISIONING_ADD","PROVISIONING_ADD_FAILED","PROVISIONING_BLOCK","PROVISIONING_BLOCK_FAILED","PROVISIONING_FAILED","PROVISIONING_UNBLOCK","PROVISIONING_UNBLOCK_FAILED","PROVISIONING_UPDATE","PROVISIONING_UPDATE_FAILED","STATUS_UNSPECIFIED","UNRECOGNIZED"],"description":"Status of SMS App."}},"components/schemas/SmsSmsAppRegionsEnum":{"id":"components/schemas/SmsSmsAppRegionsEnum","kind":"json-schema","title":"SmsSmsAppRegionsEnum","data":{"type":"string","enum":["AU","BR","CA","EU","US","UNRECOGNIZED"],"description":"List of regions of the app."}},"components/schemas/SmsConversationApiAppRegionsEnum":{"id":"components/schemas/SmsConversationApiAppRegionsEnum","kind":"json-schema","title":"SmsConversationApiAppRegionsEnum","data":{"type":"string","enum":["BR","EU","US","UNRECOGNIZED"],"description":"App region."}},"components/schemas/SmsConversationAppChannelIntegrationStatusEnum":{"id":"components/schemas/SmsConversationAppChannelIntegrationStatusEnum","kind":"json-schema","title":"SmsConversationAppChannelIntegrationStatusEnum","data":{"type":"string","enum":["ACTIVE","FAILING","PENDING","UNRECOGNIZED"],"description":"Status of the channel credentials integration."}},"components/schemas/SmsConversationApiAppDto":{"id":"components/schemas/SmsConversationApiAppDto","kind":"json-schema","title":"SmsConversationApiAppDto","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the app","uniqueItems":false},"projectId":{"type":"string","description":"ID of the app project","uniqueItems":false},"region":{"x-enumDescriptions":{"BR":"The application operates within the Brazil region.","EU":"The application operates within the Europe region.","US":"The application operates within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"App region.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SmsConversationApiAppRegionsEnum"}]},"channelStatus":{"x-enumDescriptions":{"ACTIVE":"The channel integration is active and operating as expected.","FAILING":"The channel integration is failing and requires manual attention or troubleshooting.","PENDING":"The channel integration setup or synchronization is pending completion.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Status of the channel credentials integration.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SmsConversationAppChannelIntegrationStatusEnum"}]}},"required":["id","projectId","region"]}},"components/schemas/SmsSmsAppDto":{"id":"components/schemas/SmsSmsAppDto","kind":"json-schema","title":"SmsSmsAppDto","data":{"type":"object","properties":{"id":{"type":"string","description":"SMS App id.","uniqueItems":false},"smsServiceId":{"type":"string","description":"Id of the SMS Service which the SMS App belongs to.","uniqueItems":false},"name":{"type":"string","description":"Name of SMS App.","uniqueItems":false},"status":{"x-enumDescriptions":{"ACTIVE":"The resource is active and ready to use.","BLOCKED":"The resource is blocked and cannot be used.","DELETED":"The resource has been deleted.","DEPROVISIONING":"The resource deprovisioning is currently in progress.","DEPROVISIONING_FAILED":"The resource deprovisioning failed and requires attention.","FAILED_ADD":"Adding the resource failed during the provisioning sequence.","FAILED_BLOCK":"Blocking the resource failed during the provisioning sequence.","FAILED_DELETE":"Deleting the resource failed during the provisioning sequence.","FAILED_UNBLOCK":"Unblocking the resource failed during the provisioning sequence.","FAILED_UPDATE":"Updating the resource failed during the provisioning sequence.","IN_PROGRESS_ADD":"The resource creation sequence is currently in progress.","IN_PROGRESS_BLOCK":"The resource blocking sequence is currently in progress.","IN_PROGRESS_DELETE":"The resource deletion sequence is currently in progress.","IN_PROGRESS_UNBLOCK":"The resource unblocking sequence is currently in progress.","IN_PROGRESS_UPDATE":"The resource update sequence is currently in progress.","PENDING_ADD":"The resource creation sequence is queued and waiting to start.","PENDING_BLOCK":"The resource blocking sequence is queued and waiting to start.","PENDING_DELETE":"The resource deletion sequence is queued and waiting to start.","PENDING_UNBLOCK":"The resource unblocking sequence is queued and waiting to start.","PENDING_UPDATE":"The resource update sequence is queued and waiting to start.","PROVISIONING":"The provisioning sequence is currently in progress.","PROVISIONING_ADD":"The provisioning system is actively processing resource creation.","PROVISIONING_ADD_FAILED":"The provisioning flow failed while attempting to create the resource.","PROVISIONING_BLOCK":"The provisioning system is actively processing resource blocking.","PROVISIONING_BLOCK_FAILED":"The provisioning flow failed while attempting to block the resource.","PROVISIONING_FAILED":"The provisioning sequence failed and requires technical attention.","PROVISIONING_UNBLOCK":"The provisioning system is actively processing resource unblocking.","PROVISIONING_UNBLOCK_FAILED":"The provisioning flow failed while attempting to unblock the resource.","PROVISIONING_UPDATE":"The provisioning system is actively processing a resource update.","PROVISIONING_UPDATE_FAILED":"The provisioning flow failed while attempting to update the resource.","STATUS_UNSPECIFIED":"The provisioning status was not specified by the upstream system.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"Status of SMS App.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SmsProvisioningStatesEnum"}]},"regions":{"type":"array","x-enumDescriptions":{"AU":"The application operates within the Australia region.","BR":"The application operates within the Brazil region.","CA":"The application operates within the Canada region.","EU":"The application operates within the Europe region.","US":"The application operates within the United States region.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."},"description":"List of regions of the app.","uniqueItems":false,"items":{"$ref":"#/components/schemas/SmsSmsAppRegionsEnum"}},"conversationApiAppDetails":{"description":"If set, the details of the Conversation API App the sender is connected to.","uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SmsConversationApiAppDto"}]},"test":{"type":"boolean","description":"True if the app is a test app.","uniqueItems":false}},"required":["id","smsServiceId","name","status","regions","test"]}},"components/schemas/SmsSmsAppListDto":{"id":"components/schemas/SmsSmsAppListDto","kind":"json-schema","title":"SmsSmsAppListDto","data":{"type":"object","properties":{"totalSize":{"type":"number","description":"Total size of the entries matching the search query.","uniqueItems":false},"pageSize":{"type":"number","description":"Requested size of the page.","uniqueItems":false},"previousPageToken":{"type":"string","description":"Encoded token to use in list request to fetch previous batch of entries.","uniqueItems":false},"nextPageToken":{"type":"string","description":"Encoded token to use in list request to fetch next batch of entries.","uniqueItems":false},"smsApps":{"description":"List of sms apps.","uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/SmsSmsAppDto"}}},"required":["totalSize","pageSize","smsApps"]}},"components/schemas/SmsInputSmsAppRegionsEnum":{"id":"components/schemas/SmsInputSmsAppRegionsEnum","kind":"json-schema","title":"SmsInputSmsAppRegionsEnum","data":{"type":"string","enum":["BR","EU","US"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region to create SMS app."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Allowed values for staging environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"components/schemas/SmsInputSmsAppDto":{"id":"components/schemas/SmsInputSmsAppDto","kind":"json-schema","title":"SmsInputSmsAppDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of SMS App to create.","uniqueItems":false},"region":{"x-enumDescriptions":{"BR":"The application operates within the Brazil region.","EU":"The application operates within the Europe region.","US":"The application operates within the United States region."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region to create SMS app."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Allowed values for staging environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"uniqueItems":false,"allOf":[{"$ref":"#/components/schemas/SmsInputSmsAppRegionsEnum"}]},"test":{"type":"boolean","default":false,"deprecated":true,"description":"Deprecated. This field is no longer used and will be removed in a future release.","uniqueItems":false},"convApiApp":{"type":"boolean","description":"Flag to create a new Conversation App alongside this SMS App","uniqueItems":false},"convApiAppId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of an existing Conversation API App to link with the new SMS App. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"convApiApp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"uniqueItems":false}},"required":["name","region"]}},"components/schemas/SmsUpdateSmsAppDto":{"id":"components/schemas/SmsUpdateSmsAppDto","kind":"json-schema","title":"SmsUpdateSmsAppDto","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"New name for the SMS App.","uniqueItems":false}}}},"schema_922":{"kind":"json-schema","data":{"type":"string"},"id":"schema_922"},"schema_923":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":15},"id":"schema_923"},"schema_924":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/WhatsappInputAccountPartnerInitiatedDto"},{"$ref":"#/components/schemas/WhatsappInputAccountDtoDeprecated"}]},"id":"schema_924"},"schema_925":{"kind":"json-schema","data":{"type":"string","format":"SHA256-hash"},"id":"schema_925"},"schema_926":{"kind":"json-schema","data":{"type":"string","const":"HmacSHA256","x-enumDescriptions":{"HmacSHA256":"The HMAC SHA-256 signature algorithm used to validate webhook authenticity."},"uniqueItems":false},"id":"schema_926"},"schema_927":{"kind":"json-schema","data":{"type":"string","format":"timestamp"},"id":"schema_927"},"schema_928":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Account at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappAccountDto"}]},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","payload","comment"]},"id":"schema_928"},"schema_929":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_ONBOARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Account at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappAccountDto"}]},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","payload"]},"id":"schema_929"},"schema_930":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Account at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappAccountDto"}]},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","payload"]},"id":"schema_930"},"schema_931":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Account at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappAccountDto"}]},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","payload"]},"id":"schema_931"},"schema_932":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Account at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappAccountDto"}]},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","payload"]},"id":"schema_932"},"schema_933":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_WABA_ACCOUNT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Account at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappAccountDto"}]},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","payload"]},"id":"schema_933"},"schema_934":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":100},"id":"schema_934"},"schema_935":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSenderStatesEnum"}},"id":"schema_935"},"schema_936":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappSenderStatusesEnum"}},"id":"schema_936"},"schema_937":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/WhatsappSenderInputEsDto"},{"$ref":"#/components/schemas/WhatsappInputSenderPhoneProvisioningDto"},{"$ref":"#/components/schemas/WhatsappInputSenderPartnerInitiatedDto"},{"$ref":"#/components/schemas/WhatsappSenderInputDtoDeprecated"}]},"id":"schema_937"},"schema_938":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","comment"]},"id":"schema_938"},"schema_939":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_939"},"schema_940":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_940"},"schema_941":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_941"},"schema_942":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_942"},"schema_943":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_943"},"schema_944":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_944"},"schema_945":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_945"},"schema_946":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_946"},"schema_947":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_947"},"schema_948":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_SENDER_USERNAME_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_948"},"schema_949":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":1000},"id":"schema_949"},"schema_950":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateDtoFieldMaskPathsEnum"}},"id":"schema_950"},"schema_951":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateStatesEnum"}},"id":"schema_951"},"schema_952":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateStatusesEnum"}},"id":"schema_952"},"schema_953":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WhatsappTemplateAnalyticsDateRangesEnum"},"id":"schema_953"},"schema_954":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/WhatsappTemplateListDto"},{"$ref":"#/components/schemas/WhatsappPartialTemplateListDto"}]},"id":"schema_954"},"schema_955":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload"]},"id":"schema_955"},"schema_956":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload"]},"id":"schema_956"},"schema_957":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload"]},"id":"schema_957"},"schema_958":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"newState":{"description":"New state for template.","type":"string","enum":["ARCHIVED","DISABLED","FLAGGED","PAUSED","REINSTATED","UNPAUSED"],"x-enumDescriptions":{"ARCHIVED":"The template has been archived.","DISABLED":"The template has been disabled.","FLAGGED":"The template has been flagged for review or policy compliance issues.","PAUSED":"The template has been paused and cannot be used until unpaused.","REINSTATED":"The template has been reinstated after a previous restriction was lifted.","UNPAUSED":"The template has been unpaused and is available for use."}},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload","newState"]},"id":"schema_958"},"schema_959":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case WHATSAPP_TEMPLATE_DELETED."},"children":[]}]}]}],"type":"string"}},"required":["type"]},"id":"schema_959"},"schema_960":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload"]},"id":"schema_960"},"schema_961":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload"]},"id":"schema_961"},"schema_962":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"}]},"futureCategory":{"description":"Future category for template.","type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY","UNRECOGNIZED"],"x-enumDescriptions":{"AUTHENTICATION":"Billing or functional category for authentication and verification messages.","MARKETING":"Billing or functional category for promotional or marketing messages.","UTILITY":"Billing or functional category for utility and service-related messages.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."}},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload","futureCategory"]},"id":"schema_962"},"schema_963":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WhatsappTemplateLanguagesEnum"},"id":"schema_963"},"schema_964":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/WhatsappTemplateDto"},{"$ref":"#/components/schemas/WhatsappPartialTemplateDto"}]},"id":"schema_964"},"schema_965":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_965"},"schema_966":{"kind":"json-schema","data":{"type":"number","minimum":1,"maximum":25},"id":"schema_966"},"schema_967":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_967"},"schema_968":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BundlesBundleServicesStateEnum"}},"id":"schema_968"},"schema_969":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/BundlesInputBundlesDto"}]},"id":"schema_969"},"schema_970":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUNDLE_DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this callback."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Bundle data representing the completed form.","allOf":[{"$ref":"#/components/schemas/BundlesBundlesDto"}]}},"required":["type","payload"]},"id":"schema_970"},"schema_971":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderStatesEnum"}},"id":"schema_971"},"schema_972":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkSenderStatusesEnum"}},"id":"schema_972"},"schema_973":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_973"},"schema_974":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_974"},"schema_975":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_975"},"schema_976":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","comment"]},"id":"schema_976"},"schema_977":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateStatesEnum"}},"id":"schema_977"},"schema_978":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KakaotalkTemplateStatusesEnum"}},"id":"schema_978"},"schema_979":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateDto"}]},"comment":{"description":"Comment for template.","type":"string"}},"required":["type","payload","comment"]},"id":"schema_979"},"schema_980":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateDto"}]}},"required":["type","payload"]},"id":"schema_980"},"schema_981":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KAKAOTALK_TEMPLATE_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Template at time of callback.","allOf":[{"$ref":"#/components/schemas/KakaotalkTemplateDto"}]}},"required":["type","payload"]},"id":"schema_981"},"schema_982":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_ACCOUNT_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"comment":{"description":"Comment for account.","type":"string"}},"required":["type","comment"]},"id":"schema_982"},"schema_983":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsInputSenderUseCasesEnum"},"id":"schema_983"},"schema_984":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RcsInputRcsCountryCodesEnum"}},"id":"schema_984"},"schema_985":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsUsQuestionnaireBrandCampaignVersionsEnum"},"id":"schema_985"},"schema_986":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsUsQuestionnaireVersionsEnum"},"id":"schema_986"},"schema_987":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RcsSenderStatesEnum"}},"id":"schema_987"},"schema_988":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsSenderSortColumnsEnum"},"id":"schema_988"},"schema_989":{"kind":"json-schema","data":{"$ref":"#/components/schemas/RcsSortDirectionsEnum"},"id":"schema_989"},"schema_990":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/RcsSenderDto"}]},"previousState":{"description":"The previous state of the sender.","type":"string","enum":["DRAFT","IN_PROGRESS","IN_TEST","LAUNCHED","LAUNCHING","PREPARING_LAUNCH","UNLAUNCHED","UNKNOWN"],"x-enumDescriptions":{"DRAFT":"The sender configuration is saved as a draft.","IN_PROGRESS":"The sender registration or setup is currently in progress.","IN_TEST":"The sender is currently undergoing testing.","LAUNCHED":"The sender has been successfully launched.","LAUNCHING":"The sender launch sequence is currently executing.","PREPARING_LAUNCH":"The sender configuration is being prepared for launch.","UNLAUNCHED":"The sender has been unlaunched and is disabled.","UNKNOWN":"The current state of the sender cannot be determined."}},"currentState":{"description":"The current state of the sender.","type":"string","enum":["DRAFT","IN_PROGRESS","IN_TEST","LAUNCHED","LAUNCHING","PREPARING_LAUNCH","UNLAUNCHED","UNKNOWN"],"x-enumDescriptions":{"DRAFT":"The sender configuration is saved as a draft.","IN_PROGRESS":"The sender registration or setup is currently in progress.","IN_TEST":"The sender is currently undergoing testing.","LAUNCHED":"The sender has been successfully launched.","LAUNCHING":"The sender launch sequence is currently executing.","PREPARING_LAUNCH":"The sender configuration is being prepared for launch.","UNLAUNCHED":"The sender has been unlaunched and is disabled.","UNKNOWN":"The current state of the sender cannot be determined."}},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","previousState","currentState"]},"id":"schema_990"},"schema_991":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_OPERATOR_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/RcsSenderDto"}]},"operator":{"description":"Operator.","type":"string","enum":["1und1","3","9 Mobile","A1","Africell","Airtel","Altan","AT&T","Bell","Bouygues","BSNL","C-Spire","Cape","Cell C","Citymesh","Claro","ClearSky","Coriolis Telecom","Cosmote","Deutsche Telekom","Dialog Axiata PLC","Digi","DISH Wireless","DNA","Eastlink","EE","Elisa","Entel","Ethio Telecom","Fizz","Free","Freedom","Glo","Google Fi","Guest Cloud","Hrvatski Telecom","Hutchison 3G","Iliad","Indosat Ooredoo Hutchison","Interop","Iristel","JIO","KDDI","Kpn","Kyivstar","Lebara Mobile","Legos","lifecell","Lycamobile","M1","Magenta","MEO","MobiFone","Movistar","MTN","NOS","NRJ Mobile","NTTDocomo","O2","Odido","Ooredoo","Orange","Personal","Proximus","Reliance JIO","Robi Axiata","Rogers","Salt","Sasktel","SFR","Simba","Singtel","Sky","Smart","Smartfren","Softbank","Spectrum","Spusu","Starhub","Swisscom","T-Mobile","Telcel","Tele2","Telefonica","Telekom","Telenet","Telenor","Telia","Telkom","Telkomsel","Telus","Three","TIM","TracFone","US Cellular","Verizon","Videotron","Vivo","Vodacom","Vodafone","Vodafone Idea","WindTre","Xfinity","XL","Yoigo","Unrecognized"],"x-enumDescriptions":{"3":"The 3 (Three) mobile network operator.","1und1":"The 1und1 mobile network operator.","9 Mobile":"The 9Mobile network operator.","A1":"The A1 Telekom Austria mobile network operator.","Africell":"The Africell mobile network operator.","Airtel":"The Airtel mobile network operator.","Altan":"The Altan Redes mobile network operator.","AT&T":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AT&T mobile network operator."},"children":[]}]}]}],"Bell":"The Bell Canada mobile network operator.","Bouygues":"The Bouygues Telecom mobile network operator.","BSNL":"The BSNL (Bharat Sanchar Nigam Limited) mobile network operator.","Cape":"The Cape mobile network operator.","C-Spire":"The C-Spire mobile network operator.","Cell C":"The Cell C mobile network operator.","Citymesh":"The Citymesh mobile network operator.","Claro":"The Claro mobile network operator.","ClearSky":"The ClearSky RCS messaging operator.","Coriolis Telecom":"The Coriolis Telecom mobile network operator.","Cosmote":"The Cosmote mobile network operator.","Deutsche Telekom":"The Deutsche Telekom mobile network operator.","Dialog Axiata PLC":"The Dialog Axiata PLC mobile network operator.","Digi":"The Digi mobile network operator.","DISH Wireless":"The DISH Wireless mobile network operator.","DNA":"The DNA mobile network operator.","Eastlink":"The Eastlink mobile network operator.","EE":"The EE (Everything Everywhere) mobile network operator.","Elisa":"The Elisa mobile network operator.","Entel":"The Entel mobile network operator.","Ethio Telecom":"The Ethio Telecom mobile network operator.","Fizz":"The Fizz mobile network operator.","Free":"The Free Mobile network operator.","Freedom":"The Freedom Mobile network operator.","Glo":"The Glo (Globacom) mobile network operator.","Google Fi":"The Google Fi virtual mobile network operator.","Guest Cloud":"The Guest Cloud mobile network operator.","Hrvatski Telecom":"The Hrvatski Telekom mobile network operator.","Hutchison 3G":"The Hutchison 3G mobile network operator.","Iliad":"The Iliad mobile network operator.","Indosat Ooredoo Hutchison":"The Indosat Ooredoo Hutchison mobile network operator.","Interop":"The Interop RCS messaging operator.","Iristel":"The Iristel mobile network operator.","JIO":"The Jio (Reliance Jio) mobile network operator.","KDDI":"The KDDI mobile network operator.","Kpn":"The KPN mobile network operator.","Kyivstar":"The Kyivstar mobile network operator.","Lebara Mobile":"The Lebara Mobile virtual network operator.","Legos":"The Legos mobile network operator.","lifecell":"The lifecell mobile network operator.","Lycamobile":"The Lycamobile virtual network operator.","M1":"The M1 mobile network operator.","Magenta":"The Magenta Telekom mobile network operator.","MEO":"The MEO mobile network operator.","MobiFone":"The MobiFone mobile network operator.","Movistar":"The Movistar mobile network operator.","MTN":"The MTN Group mobile network operator.","NOS":"The NOS mobile network operator.","NRJ Mobile":"The NRJ Mobile virtual network operator.","NTTDocomo":"The NTT Docomo mobile network operator.","O2":"The O2 mobile network operator.","Odido":"The Odido mobile network operator.","Ooredoo":"The Ooredoo mobile network operator.","Orange":"The Orange mobile network operator.","Personal":"The Personal mobile network operator.","Proximus":"The Proximus mobile network operator.","Reliance JIO":"The Reliance Jio mobile network operator.","Robi Axiata":"The Robi Axiata mobile network operator.","Rogers":"The Rogers Communications mobile network operator.","Salt":"The Salt mobile network operator.","Sasktel":"The SaskTel mobile network operator.","SFR":"The SFR mobile network operator.","Simba":"The Simba Telecom mobile network operator.","Singtel":"The Singtel mobile network operator.","Sky":"The Sky Mobile virtual network operator.","Smart":"The Smart Communications mobile network operator.","Smartfren":"The Smartfren mobile network operator.","Softbank":"The SoftBank mobile network operator.","Spectrum":"The Spectrum Mobile virtual network operator.","Spusu":"The spusu mobile network operator.","Starhub":"The StarHub mobile network operator.","Swisscom":"The Swisscom mobile network operator.","T-Mobile":"The T-Mobile mobile network operator.","Telcel":"The Telcel mobile network operator.","Tele2":"The Tele2 mobile network operator.","Telefonica":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Telefónica mobile network operator."},"children":[]}]}]}],"Telekom":"The Telekom mobile network operator.","Telenet":"The Telenet mobile network operator.","Telenor":"The Telenor mobile network operator.","Telia":"The Telia mobile network operator.","Telkom":"The Telkom mobile network operator.","Telkomsel":"The Telkomsel mobile network operator.","Telus":"The Telus mobile network operator.","Three":"The Three mobile network operator.","TIM":"The TIM (Telecom Italia Mobile) network operator.","TracFone":"The TracFone virtual mobile network operator.","US Cellular":"The UScellular mobile network operator.","Verizon":"The Verizon Wireless mobile network operator.","Videotron":"The Videotron mobile network operator.","Vivo":"The Vivo mobile network operator.","Vodacom":"The Vodacom mobile network operator.","Vodafone":"The Vodafone mobile network operator.","Vodafone Idea":"The Vodafone Idea mobile network operator.","WindTre":"The Wind Tre mobile network operator.","Xfinity":"The Xfinity Mobile virtual network operator.","XL":"The XL Axiata mobile network operator.","Yoigo":"The Yoigo mobile network operator.","Unrecognized":"The value returned by an upstream system is not recognized by this API version."}},"operatorCountry":{"description":"Two-letter country code in ISO 3166 standard.","type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","UNRECOGNIZED"],"x-enumDescriptions":{"AD":"The country code for Andorra.","AE":"The country code for the United Arab Emirates.","AF":"The country code for Afghanistan.","AG":"The country code for Antigua and Barbuda.","AI":"The country code for Anguilla.","AL":"The country code for Albania.","AM":"The country code for Armenia.","AO":"The country code for Angola.","AQ":"The country code for Antarctica.","AR":"The country code for Argentina.","AS":"The country code for American Samoa.","AT":"The country code for Austria.","AU":"The country code for Australia.","AW":"The country code for Aruba.","AZ":"The country code for Azerbaijan.","BA":"The country code for Bosnia and Herzegovina.","BB":"The country code for Barbados.","BD":"The country code for Bangladesh.","BE":"The country code for Belgium.","BF":"The country code for Burkina Faso.","BG":"The country code for Bulgaria.","BH":"The country code for Bahrain.","BI":"The country code for Burundi.","BJ":"The country code for Benin.","BM":"The country code for Bermuda.","BN":"The country code for Brunei.","BO":"The country code for Bolivia.","BQ":"The country code for Bonaire.","BR":"The country code for Brazil.","BS":"The country code for the Bahamas.","BT":"The country code for Bhutan.","BW":"The country code for Botswana.","BY":"The country code for Belarus.","BZ":"The country code for Belize.","CA":"The country code for Canada.","CD":"The country code for the Democratic Republic of the Congo.","CF":"The country code for the Central African Republic.","CG":"The country code for the Republic of the Congo.","CH":"The country code for Switzerland.","CI":"The country code for the Ivory Coast.","CK":"The country code for the Cook Islands.","CL":"The country code for Chile.","CM":"The country code for Cameroon.","CN":"The country code for China.","CO":"The country code for Colombia.","CR":"The country code for Costa Rica.","CU":"The country code for Cuba.","CV":"The country code for Cape Verde.","CW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Curaçao."},"children":[]}]}]}],"CY":"The country code for Cyprus.","CZ":"The country code for the Czech Republic.","DE":"The country code for Germany.","DJ":"The country code for Djibouti.","DK":"The country code for Denmark.","DM":"The country code for Dominica.","DO":"The country code for the Dominican Republic.","DZ":"The country code for Algeria.","EC":"The country code for Ecuador.","EE":"The country code for Estonia.","EG":"The country code for Egypt.","ER":"The country code for Eritrea.","ES":"The country code for Spain.","ET":"The country code for Ethiopia.","FI":"The country code for Finland.","FJ":"The country code for Fiji.","FK":"The country code for the Falkland Islands.","FM":"The country code for Micronesia.","FO":"The country code for the Faroe Islands.","FR":"The country code for France.","GA":"The country code for Gabon.","GB":"The country code for the United Kingdom of Great Britain.","GD":"The country code for Grenada.","GE":"The country code for Georgia.","GF":"The country code for French Guiana.","GG":"The country code for Guernsey.","GH":"The country code for Ghana.","GI":"The country code for Gibraltar.","GL":"The country code for Greenland.","GM":"The country code for the Gambia.","GN":"The country code for Guinea.","GP":"The country code for Guadeloupe.","GQ":"The country code for Equatorial Guinea.","GR":"The country code for Greece.","GT":"The country code for Guatemala.","GU":"The country code for Guam.","GW":"The country code for Guinea-Bissau.","GY":"The country code for Guyana.","HK":"The country code for Hong Kong.","HN":"The country code for Honduras.","HR":"The country code for Croatia.","HT":"The country code for Haiti.","HU":"The country code for Hungary.","ID":"The country code for Indonesia.","IE":"The country code for Ireland.","IL":"The country code for Israel.","IM":"The country code for the Isle of Man.","IN":"The country code for India.","IO":"The country code for the British Indian Ocean Territory.","IQ":"The country code for Iraq.","IR":"The country code for Iran.","IS":"The country code for Iceland.","IT":"The country code for Italy.","JE":"The country code for Jersey.","JM":"The country code for Jamaica.","JO":"The country code for Jordan.","JP":"The country code for Japan.","KE":"The country code for Kenya.","KG":"The country code for Kyrgyzstan.","KH":"The country code for Cambodia.","KI":"The country code for Kiribati.","KM":"The country code for Comoros.","KN":"The country code for Saint Kitts and Nevis.","KP":"The country code for North Korea.","KR":"The country code for South Korea.","KW":"The country code for Kuwait.","KY":"The country code for the Cayman Islands.","KZ":"The country code for Kazakhstan.","LA":"The country code for Laos.","LB":"The country code for Lebanon.","LC":"The country code for Saint Lucia.","LI":"The country code for Liechtenstein.","LK":"The country code for Sri Lanka.","LR":"The country code for Liberia.","LS":"The country code for Lesotho.","LT":"The country code for Lithuania.","LU":"The country code for Luxembourg.","LV":"The country code for Latvia.","LY":"The country code for Libya.","MA":"The country code for Morocco.","MC":"The country code for Monaco.","MD":"The country code for Moldova.","ME":"The country code for Montenegro.","MG":"The country code for Madagascar.","MH":"The country code for the Marshall Islands.","MK":"The country code for North Macedonia.","ML":"The country code for Mali.","MM":"The country code for Myanmar.","MN":"The country code for Mongolia.","MO":"The country code for Macao.","MP":"The country code for the Northern Mariana Islands.","MQ":"The country code for Martinique.","MR":"The country code for Mauritania.","MS":"The country code for Montserrat.","MT":"The country code for Malta.","MU":"The country code for Mauritius.","MV":"The country code for the Maldives.","MW":"The country code for Malawi.","MX":"The country code for Mexico.","MY":"The country code for Malaysia.","MZ":"The country code for Mozambique.","NA":"The country code for Namibia.","NC":"The country code for New Caledonia.","NE":"The country code for Niger.","NF":"The country code for Norfolk Island.","NG":"The country code for Nigeria.","NI":"The country code for Nicaragua.","NL":"The country code for the Netherlands.","NO":"The country code for Norway.","NP":"The country code for Nepal.","NR":"The country code for Nauru.","NU":"The country code for Niue.","NZ":"The country code for New Zealand.","OM":"The country code for Oman.","PA":"The country code for Panama.","PE":"The country code for Peru.","PF":"The country code for French Polynesia.","PG":"The country code for Papua New Guinea.","PH":"The country code for the Philippines.","PK":"The country code for Pakistan.","PL":"The country code for Poland.","PM":"The country code for Saint Pierre and Miquelon.","PR":"The country code for Puerto Rico.","PS":"The country code for Palestine.","PT":"The country code for Portugal.","PW":"The country code for Palau.","PY":"The country code for Paraguay.","QA":"The country code for Qatar.","RE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for Réunion."},"children":[]}]}]}],"RO":"The country code for Romania.","RS":"The country code for Serbia.","RU":"The country code for Russia.","RW":"The country code for Rwanda.","SA":"The country code for Saudi Arabia.","SB":"The country code for the Solomon Islands.","SC":"The country code for Seychelles.","SD":"The country code for Sudan.","SE":"The country code for Sweden.","SG":"The country code for Singapore.","SH":"The country code for Saint Helena.","SI":"The country code for Slovenia.","SK":"The country code for Slovakia.","SL":"The country code for Sierra Leone.","SM":"The country code for San Marino.","SN":"The country code for Senegal.","SO":"The country code for Somalia.","SR":"The country code for Suriname.","SS":"The country code for South Sudan.","ST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code for São Tomé and Príncipe."},"children":[]}]}]}],"SV":"The country code for El Salvador.","SX":"The country code for Sint Maarten.","SY":"The country code for Syria.","SZ":"The country code for Eswatini.","TC":"The country code for the Turks and Caicos Islands.","TD":"The country code for Chad.","TG":"The country code for Togo.","TH":"The country code for Thailand.","TJ":"The country code for Tajikistan.","TK":"The country code for Tokelau.","TL":"The country code for East Timor.","TM":"The country code for Turkmenistan.","TN":"The country code for Tunisia.","TO":"The country code for Tonga.","TR":"The country code for Turkey.","TT":"The country code for Trinidad and Tobago.","TV":"The country code for Tuvalu.","TW":"The country code for Taiwan.","TZ":"The country code for Tanzania.","UA":"The country code for Ukraine.","UG":"The country code for Uganda.","UM":"The country code for the United States Minor Outlying Islands.","US":"The country code for the United States of America.","UY":"The country code for Uruguay.","UZ":"The country code for Uzbekistan.","VC":"The country code for Saint Vincent and the Grenadines.","VE":"The country code for Venezuela.","VG":"The country code for the British Virgin Islands.","VI":"The country code for the United States Virgin Islands.","VN":"The country code for Vietnam.","VU":"The country code for Vanuatu.","WF":"The country code for Wallis and Futuna.","WS":"The country code for Samoa.","XK":"The country code for Kosovo.","YE":"The country code for Yemen.","YT":"The country code for Mayotte.","ZA":"The country code for South Africa.","ZM":"The country code for Zambia.","ZW":"The country code for Zimbabwe.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."}},"operatorPreviousStatus":{"description":"Previous country status.","type":"string","enum":["LAUNCHED","NOT_LAUNCHED","PENDING","PENDING_UNLAUNCHED","REJECTED","SUSPENDED","UNLAUNCHED","INVALID_IN_GOOGLE_MY_BUSINESS","UNRECOGNIZED"],"x-enumDescriptions":{"LAUNCHED":"The operator configuration is fully deployed, active, and operational.","NOT_LAUNCHED":"The operator profile has been registered but is not yet initialized or active.","PENDING":"The operator configuration is awaiting backend provisioning or verification approval.","PENDING_UNLAUNCHED":"The operator configuration remains unlaunched while awaiting progressive rollback or suspension steps.","REJECTED":"The operator deployment request was reviewed and rejected due to compliance or provisioning issues.","SUSPENDED":"The operator has been temporarily disabled and is currently restricted from operational routing.","UNLAUNCHED":"The operator configuration has been explicitly deactivated and retired from service.","INVALID_IN_GOOGLE_MY_BUSINESS":"The configuration parameters fail verification criteria within the Google Business Messages framework.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."}},"operatorCurrentStatus":{"type":"string","description":"Country status.","enum":["LAUNCHED","NOT_LAUNCHED","PENDING","PENDING_UNLAUNCHED","REJECTED","SUSPENDED","UNLAUNCHED","INVALID_IN_GOOGLE_MY_BUSINESS","UNRECOGNIZED"],"x-enumDescriptions":{"LAUNCHED":"The operator configuration is fully deployed, active, and operational.","NOT_LAUNCHED":"The operator profile has been registered but is not yet initialized or active.","PENDING":"The operator configuration is awaiting backend provisioning or verification approval.","PENDING_UNLAUNCHED":"The operator configuration remains unlaunched while awaiting progressive rollback or suspension steps.","REJECTED":"The operator deployment request was reviewed and rejected due to compliance or provisioning issues.","SUSPENDED":"The operator has been temporarily disabled and is currently restricted from operational routing.","UNLAUNCHED":"The operator configuration has been explicitly deactivated and retired from service.","INVALID_IN_GOOGLE_MY_BUSINESS":"The configuration parameters fail verification criteria within the Google Business Messages framework.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version."}},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","operator","operatorCountry","operatorPreviousStatus","operatorCurrentStatus"]},"id":"schema_991"},"schema_992":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_SENDER_COMMENT_ADDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/RcsSenderDto"}]},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload"]},"id":"schema_992"},"schema_993":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event, in this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"description":"Sender at time of callback.","allOf":[{"$ref":"#/components/schemas/RcsSenderDto"}]},"status":{"description":"The current status of the brand registration process.","type":"string","enum":{"Archived":"ARCHIVED","Completed":"COMPLETED","Incomplete":"INCOMPLETE","ManualReview":"MANUAL_REVIEW","New":"NEW","Pending":"PENDING","PendingReview":"PENDING_REVIEW","Rejected":"REJECTED","Unrecognized":"UNRECOGNIZED","Unspecified":"UNSPECIFIED"},"x-enumDescriptions":{"ARCHIVED":"The brand registration process has been archived.","COMPLETED":"The brand registration process has finished successfully.","INCOMPLETE":"The brand registration process is missing required information.","MANUAL_REVIEW":"The brand registration process requires manual review.","NEW":"The brand registration process is created but has not yet started.","PENDING":"The brand registration process is waiting for the next action.","PENDING_REVIEW":"The brand registration process is currently under review.","REJECTED":"The brand registration process has been reviewed and rejected.","UNRECOGNIZED":"The value returned by an upstream system is not recognized by this API version.","UNSPECIFIED":"The brand registration process status is not specified."}},"comment":{"description":"Comment for sender.","type":"string"}},"required":["type","payload","status"]},"id":"schema_993"}},"exampleStore":{"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/200/content/application~1json/examples/listWebhooksRes":{"value":{"previousPageToken":"{{TOKEN}}","nextPageToken":"{{TOKEN}}","pageSize":1,"totalSize":5,"webhooks":[{"id":"{{WEBHOOK_ID_1}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback1","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},{"id":"{{WEBHOOK_ID_2}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback2","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]}]},"key":"listWebhooksRes","summary":"List all webhooks in project","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of webhooks for the specified project. If no page token is supplied then all registered webhooks (of maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are returned in alphabetical order."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/200/content/application~1json/examples/listWebhooksRes"},"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_size-0":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-0","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_size-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_token-1":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-1","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/400/content/application~1json/examples/invalid_page_token-1"},"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq":{"value":{"secret":"{{WEBHOOK_SECRET}}","target":"https://my.server.com/callback","triggers":["ALL"]},"key":"registerWebhookNoTriggerReq","summary":"Register a webhook for all events","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookNoTriggerReq"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq":{"value":{"secret":"{{WEBHOOK_SECRET}}","target":"https://my.server.com/callback","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"registerWebhookReq","summary":"Register a webhook with specific event triggers","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/requestBody/content/application~1json/examples/registerWebhookReq"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookNoTriggerRes":{"value":{"id":"{{WEBHOOK_ID}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback","triggers":["ALL"]},"key":"registerWebhookNoTriggerRes","summary":"Register a webhook for all events","description":"\n    Example of a response when registering for all triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookNoTriggerRes"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookRes":{"value":{"id":"{{WEBHOOK_ID}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"registerWebhookRes","summary":"Register a webhook with specific event triggers","description":"\n    Example of a response when registering for specific triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/201/content/application~1json/examples/registerWebhookRes"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["target must be a string","target must be a URL address"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/409/content/application~1json/examples/webhook_exists-0":{"value":{"errorCode":"webhook_exists","message":"Webhook with the provided target already exists.","resolution":"Webhooks must have a unique target. Change the target and submit again."},"key":"webhook_exists-0","summary":"WebhookExistsError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/409/content/application~1json/examples/webhook_exists-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/424/content/application~1json/examples/webhook_limit_reached-0":{"value":{"errorCode":"webhook_limit_reached","message":"Number of webhooks has reached the limit.","resolution":"Delete some webhooks to be able to add more."},"key":"webhook_limit_reached-0","summary":"WebhookLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/triggers":{"value":{"id":"{{WEBHOOK_ID}}","target":"https://my.server.com/callback","projectId":"{{PROJECT_ID}}","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"triggers","summary":"Webhook with specific event triggers","description":"\n    Example of a response for a webhook with specific triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/triggers"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/noTriggers":{"value":{"id":"{{WEBHOOK_ID}}","target":"https://my.server.com/callback","projectId":"{{PROJECT_ID}}","triggers":["ALL"]},"key":"noTriggers","summary":"Webhook for all events","description":"\n    Example of a response for a webhook for all triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/200/content/application~1json/examples/noTriggers"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"webhookId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/404/content/application~1json/examples/webhook_not_found-0":{"value":{"errorCode":"webhook_not_found","message":"Webhook not found.","resolution":"Verify that the parameters are correct."},"key":"webhook_not_found-0","summary":"WebhookNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/404/content/application~1json/examples/webhook_not_found-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"webhookId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/examples/webhook_not_found-0":{"value":{"errorCode":"webhook_not_found","message":"Webhook not found.","resolution":"Verify that the parameters are correct."},"key":"webhook_not_found-0","summary":"WebhookNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/examples/webhook_not_found-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq":{"value":{"secret":"{{WEBHOOK_SECRET}}","target":"https://my.server.com/callback","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"updateWebhookReq","summary":"Update a webhook with specific event triggers","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookReq"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq":{"value":{"secret":"{{WEBHOOK_SECRET}}","target":"https://my.server.com/callback","triggers":["ALL"]},"key":"updateWebhookNoTriggerReq","summary":"Update a webhook to listen to all events","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookRes":{"value":{"id":"{{WEBHOOK_ID}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"updateWebhookRes","summary":"Update a webhook with specific event triggers","description":"\n    Example of a response for an update to specific triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookRes"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes":{"value":{"id":"{{WEBHOOK_ID}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback","triggers":["ALL"]},"key":"updateWebhookNoTriggerRes","summary":"Update a webhook to listen to all events","description":"\n    Example of a response for an update to all triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["target must be a string","target must be a URL address"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_id_format-2":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"webhookId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-2","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/400/content/application~1json/examples/invalid_id_format-2"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/404/content/application~1json/examples/webhook_not_found-0":{"value":{"errorCode":"webhook_not_found","message":"Webhook not found.","resolution":"Verify that the parameters are correct."},"key":"webhook_not_found-0","summary":"WebhookNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/404/content/application~1json/examples/webhook_not_found-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/409/content/application~1json/examples/webhook_exists-0":{"value":{"errorCode":"webhook_exists","message":"Webhook with the provided target already exists.","resolution":"Webhooks must have a unique target. Change the target and submit again."},"key":"webhook_exists-0","summary":"WebhookExistsError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/409/content/application~1json/examples/webhook_exists-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/put/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq":{"value":{"secret":"{{WEBHOOK_SECRET}}","target":"https://my.server.com/callback","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"updateWebhookReq","summary":"Update a webhook with specific event triggers","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookReq"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq":{"value":{"secret":"{{WEBHOOK_SECRET}}","target":"https://my.server.com/callback","triggers":["ALL"]},"key":"updateWebhookNoTriggerReq","summary":"Update a webhook to listen to all events","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/requestBody/content/application~1json/examples/updateWebhookNoTriggerReq"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookRes":{"value":{"id":"{{WEBHOOK_ID}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback","triggers":["WHATSAPP_TEMPLATE_APPROVED","WHATSAPP_TEMPLATE_REJECTED"]},"key":"updateWebhookRes","summary":"Update a webhook with specific event triggers","description":"\n    Example of a response for an update to specific triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookRes"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes":{"value":{"id":"{{WEBHOOK_ID}}","projectId":"{{PROJECT_ID}}","target":"https://my.server.com/callback","triggers":["ALL"]},"key":"updateWebhookNoTriggerRes","summary":"Update a webhook to listen to all events","description":"\n    Example of a response for an update to all triggers.\n    ","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/200/content/application~1json/examples/updateWebhookNoTriggerRes"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["target must be a string","target must be a URL address"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_id_format-2":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"webhookId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-2","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/examples/invalid_id_format-2"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/examples/webhook_not_found-0":{"value":{"errorCode":"webhook_not_found","message":"Webhook not found.","resolution":"Verify that the parameters are correct."},"key":"webhook_not_found-0","summary":"WebhookNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/examples/webhook_not_found-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/409/content/application~1json/examples/webhook_exists-0":{"value":{"errorCode":"webhook_exists","message":"Webhook with the provided target already exists.","resolution":"Webhooks must have a unique target. Change the target and submit again."},"key":"webhook_exists-0","summary":"WebhookExistsError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/409/content/application~1json/examples/webhook_exists-0"},"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1webhooks~1{webhookId}/patch/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/200/content/application~1json/examples/response":{"value":{"state":"ONBOARDED","isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":false,"wabaEnabledForDirectSend":false,"compatibleRegions":["eu","us"],"currency":"EUR"},"key":"response","summary":"Get response","description":"\n    Response with an account.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/404/content/application~1json/examples/account_not_found-0":{"value":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"key":"account_not_found-0","summary":"AccountNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/404/content/application~1json/examples/account_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/409/content/application~1json/examples/account_data_is_corrupt-0":{"value":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"key":"account_data_is_corrupt-0","summary":"AccountDataIsCorruptError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/409/content/application~1json/examples/account_data_is_corrupt-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input":{"value":{"companyLegalName":"Legal name of company","clientBusinessManagerId":"1234567890"},"key":"input","summary":"Body request","description":"\n    Example body request to create an account.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated":{"value":{"clientBusinessManagerId":"1234567890","businessManager":"SINCH_UK","wabaName":"Legal name of company","senderDetails":{"displayName":"My Sender Name","businessCategory":"OTC_DRUGS","region":"EU","metaLocalStorage":"BH"}},"key":"partnerInitiated","summary":"Body request - Partner Initiated","description":"\n    Example body request to create a partner-initiated account.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/requestBody/content/application~1json/examples/partnerInitiated"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/pending":{"value":{"isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","changes":{"status":"IN_PROGRESS","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"}},"wabaMaxPriceOnboarded":false,"compatibleRegions":["eu","us"]},"key":"pending","summary":"Create response","description":"\n    Response when successfully creating an account.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/pending"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/onboarded":{"value":{"state":"ONBOARDED","isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":false,"wabaEnabledForDirectSend":false,"compatibleRegions":["eu","us"],"currency":"EUR"},"key":"onboarded","summary":"Create response","description":"\n    Response when successfully created an account.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/201/content/application~1json/examples/onboarded"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["companyLegalName must be a string"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-1":{"value":{"errorCode":"invalid_business_manager_for_environment","message":"Invalid business manager for environment.","resolution":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK."},"key":"invalid_business_manager_for_environment-1","summary":"InvalidBusinessManagerForEnvironmentError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_payload-2":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-2","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/400/content/application~1json/examples/invalid_payload-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_exists-0":{"value":{"errorCode":"account_exists","message":"Account already exists.","resolution":"There can only be one WhatsApp account for each project. Choose another one project to create a new WhatsApp account."},"key":"account_exists-0","summary":"AccountExistsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_exists-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_data_is_corrupt-1":{"value":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"key":"account_data_is_corrupt-1","summary":"AccountDataIsCorruptError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/409/content/application~1json/examples/account_data_is_corrupt-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_ACCOUNT_COMMENT_ADDED","payload":{"state":"ONBOARDED","isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":false,"wabaEnabledForDirectSend":false,"compatibleRegions":["eu","us"],"currency":"EUR"},"comment":"Example comment"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_ACCOUNT_ONBOARDED","payload":{"state":"ONBOARDED","isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":false,"wabaEnabledForDirectSend":false,"compatibleRegions":["eu","us"],"currency":"EUR"}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Onboard/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_ACCOUNT_REJECTED","payload":{"isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","changes":{"status":"REJECTED","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"}},"wabaMaxPriceOnboarded":false,"compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_ACCOUNT_PENDING_VERIFICATION","payload":{"isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","changes":{"status":"PENDING_FACEBOOK_VERIFICATION","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"}},"wabaMaxPriceOnboarded":false,"compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_ACCOUNT_DAILY_LIMIT_CHANGED","payload":{"state":"ONBOARDED","isEmbeddedSignup":false,"businessManager":"SINCH_BR","wabaId":"1234567890","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":true,"wabaEnabledForDirectSend":false,"compatibleRegions":["br"],"primaryBusinessLocation":"BR","currency":"EUR"}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/BusinessDailyLimitChanged/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_WABA_ACCOUNT_CHANGED","payload":{"state":"ONBOARDED","isEmbeddedSignup":false,"businessManager":"SINCH_BR","wabaId":"1234567890","details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":true,"wabaEnabledForDirectSend":false,"compatibleRegions":["br"],"primaryBusinessLocation":"BR","currency":"EUR"}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp/post/callbacks/WabaInformationChanged/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_senders-0":{"value":{"errorCode":"account_has_senders","message":"Account has senders.","resolution":"Delete senders before deleting the account.","additionalInformation":{"projectId":"6a13764f-97ab-4584-b7f2-4b2d11a0ce59","senderIds":["437f8791-69ec-42af-9271-59b86b80178d","62550a35-2307-4ff1-86e4-41b0cbc7b7cb"]}},"key":"account_has_senders-0","summary":"AccountHasSendersError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_senders-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_sender_changes-1":{"value":{"errorCode":"account_has_sender_changes","message":"Account has pending sender changes.","resolution":"All sender changes must be resolved before deleting the account. If the error persists, please contact support.","additionalInformation":{"projectId":"6a13764f-97ab-4584-b7f2-4b2d11a0ce59"}},"key":"account_has_sender_changes-1","summary":"AccountHasSenderChangesError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/409/content/application~1json/examples/account_has_sender_changes-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/template_could_not_delete_drafts-0":{"value":{"errorCode":"template_could_not_delete_drafts","message":"Couldn't delete template drafts.","resolution":"Please try again later, if the error persists, please contact support."},"key":"template_could_not_delete_drafts-0","summary":"TemplateCouldNotDeleteDraftsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/template_could_not_delete_drafts-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/delete/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input":{"value":{"companyLegalName":"Updated legal name of company","wabaName":"Updated legal name of company","clientBusinessManagerId":"1234567890"},"key":"input","summary":"Body request","description":"\n      Example body request to update an account.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated":{"value":{"companyLegalName":"Updated legal name of company","wabaName":"Updated legal name of company","clientBusinessManagerId":"1234567890","senderDetails":{"displayName":"Updated display name","businessCategory":"NON_PROFIT","region":"BR","metaLocalStorage":"AE"}},"key":"partnerInitiated","summary":"Body request - Partner Initiated","description":"\n      Example body request to update an account using Partner Initiated flow.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/requestBody/content/application~1json/examples/partnerInitiated"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/200/content/application~1json/examples/response":{"value":{"state":"REJECTED","isEmbeddedSignup":false,"businessManager":"SINCH_UK","wabaId":"1234567890","changes":{"status":"IN_PROGRESS","details":{"companyLegalName":"Update legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"}},"details":{"companyLegalName":"Legal name of company","wabaName":"Legal name of company","clientBusinessManagerId":"1234567890"},"wabaMaxPriceOnboarded":false,"wabaEnabledForInsights":true,"wabaEnabledForDirectSend":false,"compatibleRegions":["eu","us"]},"key":"response","summary":"Update response","description":"\n    Response when successfully update an account.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["wabaName must be a string"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-1":{"value":{"errorCode":"no_fields_to_update","message":"No fields to be updated.","resolution":"Supply at least one field to be updated."},"key":"no_fields_to_update-1","summary":"NoFieldsToUpdateError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-2":{"value":{"errorCode":"no_fields_to_update","message":"No fields to be updated.","resolution":"Supply at least one field to be updated."},"key":"no_fields_to_update-2","summary":"NoFieldsToUpdateError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/400/content/application~1json/examples/no_fields_to_update-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/404/content/application~1json/examples/account_not_found-0":{"value":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"key":"account_not_found-0","summary":"AccountNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/404/content/application~1json/examples/account_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/409/content/application~1json/examples/account_not_updatable-0":{"value":{"errorCode":"account_not_updatable","message":"Account is not updatable.","resolution":"Only account that are in \"REJECTED\" state can be updated."},"key":"account_not_updatable-0","summary":"AccountNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/409/content/application~1json/examples/account_not_updatable-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp/patch/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-01-19T13:11:08.204Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-01-19T13:11:08.204Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List account activities response","description":"\n    Response for all account activities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/404/content/application~1json/examples/account_not_found-0":{"value":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"key":"account_not_found-0","summary":"AccountNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n      Example body request to create a comment.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n    Response when successfully creating a comment.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["comment must be longer than or equal to 1 characters"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/404/content/application~1json/examples/account_not_found-0":{"value":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"key":"account_not_found-0","summary":"AccountNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0":{"value":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"key":"account_data_is_corrupt-0","summary":"AccountDataIsCorruptError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/424/content/application~1json/examples/template_insights_not_yet_available-0":{"value":{"errorCode":"template_insights_not_yet_available","message":"Template Insights unavailable.","resolution":"Template Insights are not available yet for this WhatsApp Business account, please contact support."},"key":"template_insights_not_yet_available-0","summary":"TemplateInsightsNotYetAvailableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/424/content/application~1json/examples/template_insights_not_yet_available-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1enableTemplateAnalytics/put/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode":{"value":{"facebookCode":"FACEBOOK_CODE"},"key":"withFacebookCode","summary":"Body request facebookCode","description":"\n      Example body request to create a long lived access token.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookCode"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken":{"value":{"facebookToken":"FACEBOOK_TOKEN"},"key":"withFacebookToken","summary":"Body request facebookToken","description":"\n      Example body request to create a long lived access token.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/requestBody/content/application~1json/examples/withFacebookToken"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/201/content/application~1json/examples/response":{"value":{"longLivedAccessToken":"FACEBOOK_TOKEN"},"key":"response","summary":"Create response","description":"\n    Response when successfully creating a long lived access token.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["facebookToken must be a string"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-1":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["facebookCode must be a string"]}},"key":"invalid_input-1","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-2":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["at least one of facebookToken or facebookCode must be provided"]}},"key":"invalid_input-2","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_input-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_token-3":{"value":{"errorCode":"invalid_facebook_token","message":"Facebook token is invalid or has expired","resolution":"Check that token is correct, or create a new one and try again."},"key":"invalid_facebook_token-3","summary":"InvalidFacebookTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_token-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_code-4":{"value":{"errorCode":"invalid_facebook_code","message":"Facebook code is invalid or has expired","resolution":"Check that code is correct, or request a new one and try again."},"key":"invalid_facebook_code-4","summary":"InvalidFacebookCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_facebook_code-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager-5":{"value":{"errorCode":"invalid_business_manager","message":"Invalid business manager.","resolution":"Check that business manager is correct for project."},"key":"invalid_business_manager-5","summary":"InvalidBusinessManagerError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-6":{"value":{"errorCode":"invalid_business_manager_for_environment","message":"Invalid business manager for environment.","resolution":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK."},"key":"invalid_business_manager_for_environment-6","summary":"InvalidBusinessManagerForEnvironmentError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_payload-7":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-7","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/400/content/application~1json/examples/invalid_payload-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0":{"value":{"errorCode":"facebook_Request_limit_reached","message":"Facebook request limit reached.","resolution":"Please try again later."},"key":"facebook_Request_limit_reached-0","summary":"FacebookRequestLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/log_in_facebook_required-1":{"value":{"errorCode":"log_in_facebook_required","message":"Log in to facebook required.","resolution":"Log in to www.facebook.com and follow the instructions given."},"key":"log_in_facebook_required-1","summary":"LogInFacebookRequiredError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/log_in_facebook_required-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/internal_error-2":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-2","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1longLivedAccessToken/post/responses/500/content/application~1json/examples/internal_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input":{"value":{"facebookToken":"FACEBOOK_TOKEN"},"key":"input","summary":"Body request","description":"\n      Example body request to list WhatsApp Business Accounts details.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/200/content/application~1json/examples/response":{"value":{"wabas":[{"id":"100000000000000","numbers":[{"id":"222222222222222","displayPhoneNumber":"+48 777 777777","provisioned":false}]}]},"key":"response","summary":"List waba details response","description":"\n    Response for all waba details.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["facebookToken must be a string"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_facebook_token-1":{"value":{"errorCode":"invalid_facebook_token","message":"Facebook token is invalid or has expired","resolution":"Check that token is correct, or create a new one and try again."},"key":"invalid_facebook_token-1","summary":"InvalidFacebookTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_facebook_token-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager-2":{"value":{"errorCode":"invalid_business_manager","message":"Invalid business manager.","resolution":"Check that business manager is correct for project."},"key":"invalid_business_manager-2","summary":"InvalidBusinessManagerError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-3":{"value":{"errorCode":"invalid_business_manager_for_environment","message":"Invalid business manager for environment.","resolution":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK."},"key":"invalid_business_manager_for_environment-3","summary":"InvalidBusinessManagerForEnvironmentError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_payload-4":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-4","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/400/content/application~1json/examples/invalid_payload-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0":{"value":{"errorCode":"facebook_Request_limit_reached","message":"Facebook request limit reached.","resolution":"Please try again later."},"key":"facebook_Request_limit_reached-0","summary":"FacebookRequestLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/log_in_facebook_required-1":{"value":{"errorCode":"log_in_facebook_required","message":"Log in to facebook required.","resolution":"Log in to www.facebook.com and follow the instructions given."},"key":"log_in_facebook_required-1","summary":"LogInFacebookRequiredError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/log_in_facebook_required-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/internal_error-2":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-2","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1wabaDetails/post/responses/500/content/application~1json/examples/internal_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"flows":[{"id":"12345678765432","name":"flow1","status":"FLOW_STATUS_PUBLISHED"},{"id":"98765676543654567","name":"flow2","status":"FLOW_STATUS_DRAFT"}]},"key":"response","summary":"Flows response","description":"\n    Successful response to a \"list flows in a project\" query.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/200/content/application~1json/examples/response":{"value":{"screens":[{"id":"MY_FIRST_SCREEN"}]},"key":"response","summary":"Flow screens response","description":"\n    Successful response to a \"list screens for a flow\" query.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_not_found-1":{"value":{"errorCode":"flow_not_found","message":"Flow not found.","resolution":"Verify that the parameters are correct."},"key":"flow_not_found-1","summary":"FlowNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_not_found-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_screens_not_found-2":{"value":{"errorCode":"flow_screens_not_found","message":"Flow screens not found.","resolution":"Verify if the flow screens exist."},"key":"flow_screens_not_found-2","summary":"FlowScreensNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/404/content/application~1json/examples/flow_screens_not_found-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1flows~1{flowId}~1screens/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"senders":[{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]},{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}]},"key":"response","summary":"List response","description":"\n    Response with senders.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-1":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-1","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-2":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-2","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3":{"value":{"errorCode":"invalid_filter_states","message":"Invalid filterStates.","resolution":"Verify that the filterStates used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"ACTIVE, IN_PROGRESS, INACTIVE, PENDING_VERIFICATION, SUSPENDED, ERROR"}},"key":"invalid_filter_states-3","summary":"InvalidFilterStatesError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4":{"value":{"errorCode":"invalid_filter_statuses","message":"Invalid filter statuses.","resolution":"Verify that the filterStatuses used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"DRAFT, ERROR, IN_PROGRESS, REJECTED"}},"key":"invalid_filter_statuses-4","summary":"InvalidFilterStatusesError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es":{"value":{"region":"EU","metaLocalStorage":"DE","wabaId":"11111111111111","phoneNumberId":"222222222222222","authenticationCode":"123asdf123"},"key":"es","summary":"Body request for ES","description":"\n        Example body request to create an ES.\n        ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/es"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning":{"value":{"details":{"countryCode":"49","phoneNumber":"1701234567","displayName":"Demo sender"}},"key":"phoneProvisioning","summary":"Body request for new-number sender flow","description":"\n      Example body request to create a sender with provisioned phone number.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/phoneProvisioning"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated":{"value":{"region":"EU","metaLocalStorage":"DE","phoneNumberProvider":"CUSTOMER","details":{"countryCode":"48","phoneNumber":"777777777","displayName":"Test name","description":"Test description","vertical":"EDUCATION","email":"test@test.com","address":"Test address","websiteOne":"https://example-1.com","about":"Test about","photoUrl":"https://example.com/photos/1.png"}},"key":"partnerInitiated","summary":"Body request for Partner Initiated Sender","description":"\n      Example body request to create a partner-initiated sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/partnerInitiated"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken":{"value":{"region":"EU","metaLocalStorage":"DE","wabaId":"11111111111111","phoneNumberId":"222222222222222","facebookAccessToken":"FACEBOOK_TOKEN","name":"Example name","details":{"displayName":"Test name","description":"Test description","vertical":"EDUCATION","email":"test@test.com","address":"Test address","websiteOne":"https://example-1.com","about":"Test about","photoUrl":"https://example.com/photos/1.png"}},"key":"esWithFacebookToken","summary":"Body request for ES with Facebook token [Deprecated]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example body request to create an ES. [Deprecated]"},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookToken"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode":{"value":{"region":"EU","metaLocalStorage":"DE","wabaId":"11111111111111","phoneNumberId":"222222222222222","facebookCode":"FACEBOOK_CODE","name":"Example name","details":{"displayName":"Test name","description":"Test description","vertical":"EDUCATION","email":"test@test.com","address":"Test address","websiteOne":"https://example-1.com","about":"Test about","photoUrl":"https://example.com/photos/1.png"}},"key":"esWithFacebookCode","summary":"Body request for ES with Facebook code [Deprecated]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example body request to create an ES. [Deprecated]"},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/requestBody/content/application~1json/examples/esWithFacebookCode"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/201/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]},"key":"response","summary":"Create response","description":"\n    Response when successfully creating a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["details should not be null or undefined"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_facebook_token-2":{"value":{"errorCode":"invalid_facebook_token","message":"Facebook token is invalid or has expired","resolution":"Check that token is correct, or create a new one and try again."},"key":"invalid_facebook_token-2","summary":"InvalidFacebookTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_facebook_token-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager-3":{"value":{"errorCode":"invalid_business_manager","message":"Invalid business manager.","resolution":"Check that business manager is correct for project."},"key":"invalid_business_manager-3","summary":"InvalidBusinessManagerError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-4":{"value":{"errorCode":"invalid_business_manager_for_environment","message":"Invalid business manager for environment.","resolution":"Verify that business manager is valid for environment. Allowed business managers for environment SINCH_AMERICA, SINCH_UK."},"key":"invalid_business_manager_for_environment-4","summary":"InvalidBusinessManagerForEnvironmentError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_business_manager_for_environment-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-5":{"value":{"errorCode":"file_invalid_mime_type","message":"details.photoUrl: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png, image/webp."},"key":"file_invalid_mime_type-5","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_payload-6":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-6","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/400/content/application~1json/examples/invalid_payload-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0":{"value":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"key":"account_data_is_corrupt-0","summary":"AccountDataIsCorruptError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_waba_id-1":{"value":{"errorCode":"wrong_waba_id","message":"Different wabaId already exists for sub account / project.","resolution":"Please check if the WhatsApp Business Account is correct, or don't provide the WhatsApp Business Account in the request for this project."},"key":"wrong_waba_id-1","summary":"WrongWabaIdError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_waba_id-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/not_found_waba_id-2":{"value":{"errorCode":"not_found_waba_id","message":"Not found wabaId.","resolution":"Verify that exist any WhatsApp Business Account for sub account / project."},"key":"not_found_waba_id-2","summary":"NotFoundWabaIdError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/not_found_waba_id-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/too_many_waba_id-3":{"value":{"errorCode":"too_many_waba_id","message":"Too many wabaId.","resolution":"We can't automatically select WhatsApp Business Account for this project, please provide WhatsApp Business Account in the request."},"key":"too_many_waba_id-3","summary":"TooManyWabaIdError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/too_many_waba_id-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/waba_id_used-4":{"value":{"errorCode":"waba_id_used","message":"WabaId is used.","resolution":"WhatsApp Business Account is already used in another project. Use another id or create the sender under the correct project."},"key":"waba_id_used-4","summary":"WabaIdUsedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/waba_id_used-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_business_manager-5":{"value":{"errorCode":"wrong_business_manager","message":"Different business manager already exists for sub account / project.","resolution":"Please check if the Business Manager is correct, or don't provide the Business Manager in the request for this project."},"key":"wrong_business_manager-5","summary":"WrongBusinessManagerError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/wrong_business_manager-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/used_phone_number_id-6":{"value":{"errorCode":"used_phone_number_id","message":"Used phoneNumberId.","resolution":"PhoneNumberId is used. Choose another one."},"key":"used_phone_number_id-6","summary":"UsedPhoneNumberIdError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/used_phone_number_id-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/provisioned_phone_number_id-7":{"value":{"errorCode":"provisioned_phone_number_id","message":"Provisioned phoneNumberId.","resolution":"PhoneNumberId is provisioned. Choose another one."},"key":"provisioned_phone_number_id-7","summary":"ProvisionedPhoneNumberIdError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/provisioned_phone_number_id-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/all_phone_number_id_provisioned-8":{"value":{"errorCode":"all_phone_number_id_provisioned","message":"All phoneNumberId are provisioned.","resolution":"All phoneNumberId are provisioned. Add another one."},"key":"all_phone_number_id_provisioned-8","summary":"AllPhoneNumberIdProvisionedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/all_phone_number_id_provisioned-8"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/invalid_waba_id_or_phone_number_id_for_region-9":{"value":{"errorCode":"invalid_waba_id_or_phone_number_id_for_region","message":"Invalid wabaId or phoneNumberId for region.","resolution":"Please check if the WhatsApp Business Account, phone number id and region are correct."},"key":"invalid_waba_id_or_phone_number_id_for_region-9","summary":"InvalidWabaIdOrPhoneNumberIdForRegionError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/invalid_waba_id_or_phone_number_id_for_region-9"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_not_found-10":{"value":{"errorCode":"file_not_found","message":"details.photoUrl: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-10","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_not_found-10"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-11":{"value":{"errorCode":"file_size_too_large","message":"details.photoUrl: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 5MB."},"key":"file_size_too_large-11","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-11"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-12":{"value":{"errorCode":"file_has_wrong_dimensions","message":"details.photoUrl: image has wrong dimensions.","resolution":"Try again with image dimensions: min 192 x 192 px & max 640 x 640 px."},"key":"file_has_wrong_dimensions-12","summary":"FileHasWrongDimensionsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-12"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-13":{"value":{"errorCode":"file_unexpected_error","message":"details.photoUrl: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-13","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-13"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0":{"value":{"errorCode":"facebook_Request_limit_reached","message":"Facebook request limit reached.","resolution":"Please try again later."},"key":"facebook_Request_limit_reached-0","summary":"FacebookRequestLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/facebook_Request_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/log_in_facebook_required-1":{"value":{"errorCode":"log_in_facebook_required","message":"Log in to facebook required.","resolution":"Log in to www.facebook.com and follow the instructions given."},"key":"log_in_facebook_required-1","summary":"LogInFacebookRequiredError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/log_in_facebook_required-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/internal_error-2":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-2","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/responses/500/content/application~1json/examples/internal_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_COMMENT_ADDED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"INACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]},"comment":"Example comment"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_ACTIVE","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_INACTIVE","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"INACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_PENDING_VERIFICATION","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PENDING_VERIFICATION","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/PendingVerification/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_REJECTED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","changes":{"status":"REJECTED","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_ERROR","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","changes":{"status":"ERROR","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"errorReason":"Reach out to support at support@sinch.com"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Error/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","dailyLimit":"TIER_100K","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"YELLOW","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_DELETED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","region":"UNRECOGNIZED","metaLocalStorage":"UNRECOGNIZED","cloudApi":false,"businessManager":"SINCH_UK","compatibleRegions":[]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/Deleted/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_USERNAME_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders/post/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]},"key":"response","summary":"Get response","description":"\n    Response with a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0":{"value":{"errorCode":"sender_already_deleted","message":"A sender has been deleted within 30 days.","resolution":"Wait the required time."},"key":"sender_already_deleted-0","summary":"SenderAlreadyDeletedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default":{"value":{"details":{"displayName":"Test name update","description":"Test description update","email":null,"address":null,"websiteTwo":"https://example-2.com","about":"Test about update","photoUrl":"https://example.com/photos/2.png"}},"key":"default","summary":"Body request","description":"\n      Example body request to update a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/default"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username":{"value":{"details":{"username":"Username"}},"key":"username","summary":"Body request with username","description":"\n      Example body request to update a sender with username.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/username"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]},"key":"response","summary":"Update response","description":"\n    Response when successfully update a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["details.displayName must be a string","details.displayName must be longer than or equal to 1 characters","details.displayName must be shorter than or equal to 128 characters","details.displayName should not be equal to null"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_username_not_available-2":{"value":{"errorCode":"sender_username_not_available","message":"Sender username is not available.","resolution":"Choose another username and try again."},"key":"sender_username_not_available-2","summary":"SenderUsernameNotAvailableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_username_not_available-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_phone_number_not_registered_with_meta_cloud_api-3":{"value":{"errorCode":"sender_phone_number_not_registered_with_meta_cloud_api","message":"Sender phone number is not registered with Cloud API.","resolution":"Register the phone number with WhatsApp Cloud API and try again."},"key":"sender_phone_number_not_registered_with_meta_cloud_api-3","summary":"SenderPhoneNumberNotRegisteredWithMetaCloudApiError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/sender_phone_number_not_registered_with_meta_cloud_api-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-4":{"value":{"errorCode":"no_fields_to_update","message":"No fields to be updated.","resolution":"Supply at least one field to be updated."},"key":"no_fields_to_update-4","summary":"NoFieldsToUpdateError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-5":{"value":{"errorCode":"file_invalid_mime_type","message":"details.photoUrl: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png, image/webp."},"key":"file_invalid_mime_type-5","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-6":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-6","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-0":{"value":{"errorCode":"sender_not_updatable","message":"Sender is not updatable.","resolution":"Updates are only supported by senders with state: ACTIVE."},"key":"sender_not_updatable-0","summary":"SenderNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-1":{"value":{"errorCode":"sender_changes_not_updatable","message":"Sender is not updatable.","resolution":"Updates are only supported by senders changes with status: DRAFT, REJECTED."},"key":"sender_changes_not_updatable-1","summary":"SenderChangesNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_display_name_update_not_allowed-2":{"value":{"errorCode":"sender_display_name_update_not_allowed","message":"Sender display name update is not allowed.","resolution":"Sender display name cannot be updated while it is being reviewed. Please try again later."},"key":"sender_display_name_update_not_allowed-2","summary":"SenderDisplayNameUpdateNotAllowedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_display_name_update_not_allowed-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_username_update_not_available-3":{"value":{"errorCode":"sender_username_update_not_available","message":"Sender username update is not available.","resolution":"Only \"ACTIVE\" senders can have their username updated."},"key":"sender_username_update_not_available-3","summary":"SenderUsernameUpdateNotAvailableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/sender_username_update_not_available-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_not_found-4":{"value":{"errorCode":"file_not_found","message":"details.photoUrl: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-4","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_not_found-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_size_too_large-5":{"value":{"errorCode":"file_size_too_large","message":"details.photoUrl: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 5MB."},"key":"file_size_too_large-5","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_size_too_large-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_has_wrong_dimensions-6":{"value":{"errorCode":"file_has_wrong_dimensions","message":"details.photoUrl: image has wrong dimensions.","resolution":"Try again with image dimensions: min 192 x 192 px & max 640 x 640 px."},"key":"file_has_wrong_dimensions-6","summary":"FileHasWrongDimensionsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_has_wrong_dimensions-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-7":{"value":{"errorCode":"file_unexpected_error","message":"details.photoUrl: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-7","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_COMMENT_ADDED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"INACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]},"comment":"Example comment"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_ACTIVE","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Active/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_INACTIVE","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"INACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Inactive/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_PENDING_VERIFICATION","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PENDING_VERIFICATION","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/PendingVerification/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_REJECTED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","changes":{"status":"REJECTED","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_ERROR","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","changes":{"status":"ERROR","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"errorReason":"Reach out to support at support@sinch.com"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Error/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_DAILY_LIMIT_CHANGED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","dailyLimit":"TIER_100K","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DailyLimitChanged/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_QUALITY_RATING_CHANGED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"YELLOW","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/QualityRatingChanged/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_DELETED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","region":"UNRECOGNIZED","metaLocalStorage":"UNRECOGNIZED","cloudApi":false,"businessManager":"SINCH_UK","compatibleRegions":[]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_DISPLAY_NAME_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/DisplayNameUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_SENDER_USERNAME_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"ACTIVE","changes":{"status":"IN_PROGRESS","details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"}},"details":{"displayName":"Test name","description":"Test description","vertical":"PROFESSIONAL_SERVICES","email":"test@test.com","address":"Test address","about":"Test about","websiteOne":"https://example-1.com","photoUrl":"https://example.com/photos/1.png"},"metadata":{"displayName":{"value":"New Display Name","status":"PENDING"}},"created":"2023-01-19T13:11:08.204Z","modified":"2023-01-19T13:11:08.204Z","region":"EU","metaLocalStorage":"DE","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"maxTps":10,"qualityRating":"GREEN","bearerToken":"aaaaAAAA.bbbbBBBB.ccccCCCC","cloudApi":true,"countryCode":"48","phoneNumber":"777777777","numberProvider":"CUSTOMER","businessManager":"SINCH_UK","compatibleRegions":["eu","us"]}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}/patch/callbacks/UsernameUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-01-19T13:11:08.204Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-01-19T13:11:08.204Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List sender activities response","description":"\n    Response for all sender activities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-1","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-2","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0":{"value":{"errorCode":"sender_changes_not_found","message":"Sender changes not found.","resolution":"Verify that the parameters are correct."},"key":"sender_changes_not_found-0","summary":"SenderChangesNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0":{"value":{"errorCode":"sender_changes_not_deletable","message":"Sender changes is not deletable.","resolution":"Only DRAFT, REJECTED, ERROR senders changes can be marked for deletion."},"key":"sender_changes_not_deletable-0","summary":"SenderChangesNotDeletableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n      Example body request to create a comment.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n    Response when successfully creating a comment.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-1":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["comment must be longer than or equal to 1 characters"]}},"key":"invalid_input-1","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-2","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input":{"value":{"method":"SMS"},"key":"input","summary":"Body request","description":"\n      Example body request to register.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","method":"SMS","accepted":"2023-01-19T13:11:08.204Z","verificationCodeSent":true},"key":"response","summary":"Register response","description":"\n    Response when successfully register a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/phoneAlreadyRegistered":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","method":"SMS","accepted":"2023-01-19T13:11:08.204Z","verificationCodeSent":false},"key":"phoneAlreadyRegistered","summary":"Phone number already registered","description":"\n    Response when the phone number is already registered.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/200/content/application~1json/examples/phoneAlreadyRegistered"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["method must be one of the following values: SMS, VOICE"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/sender_request_code_failed-2":{"value":{"errorCode":"sender_request_code_failed","message":"Request code failed.","resolution":"Request code failed. Please try again in some time."},"key":"sender_request_code_failed-2","summary":"SenderRequestCodeFailedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/sender_request_code_failed-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_payload-3":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-3","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/400/content/application~1json/examples/invalid_payload-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0":{"value":{"errorCode":"not_allowed_register","message":"Sender not allowed to be registered.","resolution":"Only \"PENDING_VERIFICATION\" sender can be registered."},"key":"not_allowed_register-0","summary":"NotAllowedRegisterError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/sender-number-not-approved-for-enterprise-1":{"value":{"errorCode":"sender-number-not-approved-for-enterprise","message":"Sender number not approved for enterprise.","resolution":"This number has not been approved for an enterprise. Please contact support for more info."},"key":"sender-number-not-approved-for-enterprise-1","summary":"SenderNumberNotApprovedForEnterpriseError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/409/content/application~1json/examples/sender-number-not-approved-for-enterprise-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-register-too-many-requests-0":{"value":{"errorCode":"sender-register-too-many-requests","message":"Sender register too many requests.","resolution":"Register sender request limits reached. Please try again later."},"key":"sender-register-too-many-requests-0","summary":"SenderRegisterTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-register-too-many-requests-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-already-registered-1":{"value":{"errorCode":"sender-already-registered","message":"Sender already registered.","resolution":"Verify that the parameters are correct."},"key":"sender-already-registered-1","summary":"SenderAlreadyRegisteredError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/sender-already-registered-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/too_many_invalid_verification_codes-2":{"value":{"errorCode":"too_many_invalid_verification_codes","message":"Too many invalid verification codes.","resolution":"You've tried too many invalid verification codes. Please try again later."},"key":"too_many_invalid_verification_codes-2","summary":"TooManyInvalidVerificationCodesError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/429/content/application~1json/examples/too_many_invalid_verification_codes-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1suggestedUsernames/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input":{"value":{"code":"123456"},"key":"input","summary":"Body request","description":"\n      Example body request to verify a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["code must be a string","code must be exactly 6 characters"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_payload-2":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-2","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/400/content/application~1json/examples/invalid_payload-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0":{"value":{"errorCode":"not_allowed_verify","message":"Sender not allowed to be verified.","resolution":"Only \"PENDING_VERIFICATION\" sender can be verified."},"key":"not_allowed_verify-0","summary":"NotAllowedVerifyError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/wrong_otp-1":{"value":{"errorCode":"wrong_otp","message":"Sender verification failed due to wrong OTP.","resolution":"Please make sure that the correct OTP code is entered."},"key":"wrong_otp-1","summary":"WrongOtpError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/409/content/application~1json/examples/wrong_otp-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1senders~1{senderId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/200/content/application~1json/examples/response":{"value":{"solutions":[{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":false},{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":true},{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":false}]},"key":"response","summary":"List response","description":"\n    Response with solutions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input":{"value":{"accessToken":"3cca3b57-e388-4aaa-abe3-ecb1c0c8265f","businessManager":"SINCH_UK","details":{"name":"Test name"}},"key":"input","summary":"Body request for solution","description":"\n    Example body request to create a solution.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/201/content/application~1json/examples/response":{"value":{"solutions":[{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":false},{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":false},{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":false}],"failedSolutions":[]},"key":"response","summary":"Create response","description":"\n    Response when successfully creating a solution.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/assignedResponse":{"value":{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":true},"key":"assignedResponse","summary":"Get assigned solution response","description":"\n    Response with assigned solution.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/assignedResponse"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/notAssignedResponse":{"value":{"id":"123","details":{"name":"Test name"},"ownerApp":{"id":456,"name":"Test owner app name"},"partnerApp":{"id":789,"name":"Test partner app name"},"assigned":false},"key":"notAssignedResponse","summary":"Get unassigned solution response","description":"\n    Response with unassigned solution.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/200/content/application~1json/examples/notAssignedResponse"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/solution_not_found-1":{"value":{"errorCode":"solution_not_found","message":"Solution not found.","resolution":"Verify that the parameters are correct."},"key":"solution_not_found-1","summary":"SolutionNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/404/content/application~1json/examples/solution_not_found-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/solution_not_found-1":{"value":{"errorCode":"solution_not_found","message":"Solution not found.","resolution":"Verify that the parameters are correct."},"key":"solution_not_found-1","summary":"SolutionNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/404/content/application~1json/examples/solution_not_found-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/409/content/application~1json/examples/solution_cannot_be_reassigned-0":{"value":{"errorCode":"solution_cannot_be_reassigned","message":"Project is already onboarded, can't reassign solution","resolution":"Verify that the parameters are correct."},"key":"solution_cannot_be_reassigned-0","summary":"SolutionCannotBeReassignedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/409/content/application~1json/examples/solution_cannot_be_reassigned-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1solutions~1{solutionId}~1assign/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-2","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_states-3":{"value":{"errorCode":"invalid_filter_states","message":"Invalid filterStates.","resolution":"Verify that the filterStates used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"APPROVED, DISABLED, PAUSED, PENDING, REJECTED"}},"key":"invalid_filter_states-3","summary":"InvalidFilterStatesError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_states-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4":{"value":{"errorCode":"invalid_filter_statuses","message":"Invalid filter statuses.","resolution":"Verify that the filterStatuses used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"DRAFT, IN_PROGRESS, REJECTED"}},"key":"invalid_filter_statuses-4","summary":"InvalidFilterStatusesError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_fields-5":{"value":{"errorCode":"invalid_fields","message":"Invalid fields.","resolution":"Verify that the fields used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"whatsappId, state, name, language, category, rejectionCode, qualityScore, changes, changes.status, changes.allowCategoryChange, changes.details, changes.details.components, changes.details.components.0.type, changes.details.components.0.format, changes.details.components.0.text, changes.details.components.0.example, changes.details.components.0.example.url, changes.details.components.0.examples, changes.details.components.0.addSecurityRecommendation, changes.details.components.0.codeExpirationMinutes, changes.details.components.0.buttons, changes.details.components.0.buttons.0.type, changes.details.components.0.buttons.0.text, changes.details.components.0.buttons.0.phoneNumber, changes.details.components.0.buttons.0.url, changes.details.components.0.buttons.0.example, changes.details.components.0.buttons.0.otpType, changes.details.components.0.buttons.0.autofillText, changes.details.components.0.buttons.0.packageName, changes.details.components.0.buttons.0.signatureHash, changes.details.components.0.buttons.0.supportedApps, changes.details.components.0.buttons.0.supportedApps.0.packageName, changes.details.components.0.buttons.0.supportedApps.0.signatureHash, changes.details.components.0.buttons.0.zeroTapTermsAccepted, changes.details.components.0.buttons.0.flowId, changes.details.components.0.buttons.0.flowAction, changes.details.components.0.buttons.0.navigateScreen, changes.details.components.0.hasExpiration, changes.details.messageSendTtlSeconds, changes.details.optimization, details, details.components, details.components.0.type, details.components.0.format, details.components.0.text, details.components.0.example, details.components.0.example.url, details.components.0.examples, details.components.0.addSecurityRecommendation, details.components.0.codeExpirationMinutes, details.components.0.buttons, details.components.0.buttons.0.type, details.components.0.buttons.0.text, details.components.0.buttons.0.phoneNumber, details.components.0.buttons.0.url, details.components.0.buttons.0.example, details.components.0.buttons.0.otpType, details.components.0.buttons.0.autofillText, details.components.0.buttons.0.packageName, details.components.0.buttons.0.signatureHash, details.components.0.buttons.0.supportedApps, details.components.0.buttons.0.supportedApps.0.packageName, details.components.0.buttons.0.supportedApps.0.signatureHash, details.components.0.buttons.0.zeroTapTermsAccepted, details.components.0.buttons.0.flowId, details.components.0.buttons.0.flowAction, details.components.0.buttons.0.navigateScreen, details.components.0.hasExpiration, details.messageSendTtlSeconds, details.optimization, analytics, analytics.0.sent, analytics.0.delivered, analytics.0.read, analytics.0.start, analytics.0.end, analytics.0.buttons, analytics.0.buttons.0.type, analytics.0.buttons.0.content, analytics.0.buttons.0.clicks, isMetaGenerated"}},"key":"invalid_fields-5","summary":"InvalidFieldsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/400/content/application~1json/examples/invalid_fields-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull":{"value":{"name":"my_template","category":"MARKETING","language":"EN","details":{"components":[{"type":"HEADER","format":"LOCATION"},{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"HEADER","format":"DOCUMENT","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true},{"type":"FOOTER","text":"To track your order please click the 'Track Your Order' button","codeExpirationMinutes":5},{"type":"BUTTONS","buttons":[{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"},{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"OTP","otpType":"COPY_CODE","text":"Example text."},{"type":"FLOW","text":"Start Flow","flowId":"flow-id","navigateScreen":"QUESTION_ONE","flowAction":"NAVIGATE"},{"type":"REQUEST_CONTACT_INFO"},{"type":"ORDER_DETAILS"},{"type":"COPY_CODE","examples":["WINTER27"]}]},{"type":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"]},{"type":"BUTTONS","buttons":[{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"}]}]}]}]}},"key":"marketingOrUtilityFull","summary":"Marketing or Utility full example","description":"\n    Full body to create a Marketing or Utility template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityFull"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization":{"value":{"name":"my_template","category":"MARKETING","language":"EN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true}],"optimization":{"bidAmount":500,"bidStrategy":"LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}}},"key":"marketingWithOptimization","summary":"Marketing template with dynamic pricing optimization","description":"\n    Body example to create a Marketing template with dynamic pricing optimization.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingWithOptimization"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum":{"value":{"name":"my_template","category":"UTILITY","language":"EN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true}]}},"key":"marketingOrUtilityMinimum","summary":"Minimalist Marketing or Utility example","description":"\n    Minimalist body to create a Marketing or Utility template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/marketingOrUtilityMinimum"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull":{"value":{"name":"my_template","category":"AUTHENTICATION","language":"EN","details":{"components":[{"type":"BODY","addSecurityRecommendation":true},{"type":"FOOTER","codeExpirationMinutes":62},{"type":"BUTTONS","buttons":[{"type":"OTP","otpType":"ONE_TAP","text":"My copy code text","autofillText":"My autofill text","packageName":"com.android.chrome","signatureHash":"sample+hash","supportedApps":[{"packageName":"com.android.chrome","signatureHash":"sample+hash"}]}]},{"type":"BUTTONS","buttons":[{"type":"OTP","otpType":"ZERO_TAP","text":"My copy code text","autofillText":"My autofill text","packageName":"com.android.chrome","signatureHash":"sample+hash","supportedApps":[{"packageName":"com.android.chrome","signatureHash":"sample+hash"}],"zeroTapTermsAccepted":true}]}],"messageSendTtlSeconds":360}},"key":"authenticationFull","summary":"Authentication full example","description":"\n    Full body to create an Authentication template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationFull"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum":{"value":{"name":"my_template","category":"AUTHENTICATION","language":"EN","details":{"components":[{"type":"BODY","addSecurityRecommendation":false},{"type":"BUTTONS","buttons":[{"type":"OTP","otpType":"COPY_CODE","text":"Copy code"}]}]}},"key":"authenticationMinimum","summary":"Minimalist Authentication example","description":"\n    Minimalist body to create an Authentication template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/authenticationMinimum"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility":{"value":{"name":"my_template","category":"UTILITY","language":"EN","details":{"components":[{"type":"BUTTONS","buttons":[{"type":"FLOW","flowId":"flow-id","text":"Start Flow","navigateScreen":"QUESTION_ONE","flowAction":"NAVIGATE"}]}]}},"key":"flowUtility","summary":"Start Flow Utility example","description":"\n    Body example to create a Flow template of utility category.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowUtility"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing":{"value":{"name":"my_template","category":"MARKETING","language":"EN","details":{"components":[{"type":"BUTTONS","buttons":[{"type":"FLOW","flowId":"flow-id","text":"Start Flow","navigateScreen":"QUESTION_ONE","flowAction":"NAVIGATE"}]}]}},"key":"flowMarketing","summary":"Start Flow Marketing example","description":"\n    Body example to create a Flow template of marketing category.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/requestBody/content/application~1json/examples/flowMarketing"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/201/content/application~1json/examples/response":{"value":{"name":"My WhatsApp Template","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","changes":{"status":"DRAFT","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"HEADER","format":"DOCUMENT","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"HEADER","format":"LOCATION"},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true},{"type":"FOOTER","text":"To track your order please click the 'Track Your Order' button","codeExpirationMinutes":5},{"type":"BUTTONS","buttons":[{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"},{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"OTP","otpType":"COPY_CODE","text":"Example text."},{"type":"REQUEST_CONTACT_INFO","text":"Share Contact Info"},{"type":"ORDER_DETAILS","text":"Copy Pix code"},{"type":"COPY_CODE","text":"Copy offer code","examples":["WINTER27"]}]},{"type":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"]},{"type":"BUTTONS","buttons":[{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"}]}]}]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}}},"analytics":[],"isMetaGenerated":false},"key":"response","summary":"Create response","description":"\n    Response when successfully creating a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["category must be one of the following values: AUTHENTICATION, MARKETING, UTILITY"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_policies_violations-2":{"value":{"errorCode":"template_policies_violations","message":"Your message couldn't be sent because it includes content that other people on Facebook have reported as abusive.","resolution":"Remove violating content. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_policies_violations-2","summary":"TemplatePoliciesViolationsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_policies_violations-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_check_media_file_size-3":{"value":{"errorCode":"template_check_media_file_size","message":"Failed to check media file size.","resolution":"Ensure media file URL is correct and then try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_check_media_file_size-3","summary":"TemplateCheckMediaFileSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_check_media_file_size-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_dynamic_pricing_not_available-4":{"value":{"errorCode":"template_dynamic_pricing_not_available","message":"Dynamic pricing is not available for this account.","resolution":"Enable dynamic pricing prerequisites for the WhatsApp Business Account before retrying."},"key":"template_dynamic_pricing_not_available-4","summary":"TemplateDynamicPricingNotAvailableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_dynamic_pricing_not_available-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_category-5":{"value":{"errorCode":"template_invalid_category","message":"Template invalid category.","resolution":"Verify that categories are correct: AUTHENTICATION, MARKETING, UTILITY."},"key":"template_invalid_category-5","summary":"TemplateInvalidCategoryError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_category-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_button_example-6":{"value":{"errorCode":"template_invalid_button_example","message":"Invalid button example.","resolution":"Only dynamic URL buttons are allowed to have an example."},"key":"template_invalid_button_example-6","summary":"TemplateInvalidButtonExampleError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_invalid_button_example-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-7":{"value":{"errorCode":"template_media_file_size_exceeds_maximum_file_size_limit","message":"Template media file size exceeds maximum file size limit.","resolution":"Try again with a smaller file."},"key":"template_media_file_size_exceeds_maximum_file_size_limit-7","summary":"TemplateMediaFileSizeExceedsMaximumFileSizeLimitError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/file_invalid_mime_type-8":{"value":{"errorCode":"file_invalid_mime_type","message":"details.components[0].headerExample.media.url: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png, application/pdf, video/3gp, video/mp4."},"key":"file_invalid_mime_type-8","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/file_invalid_mime_type-8"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_payload-9":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-9","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/400/content/application~1json/examples/invalid_payload-9"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_exists-1":{"value":{"errorCode":"template_exists","message":"Template already exists.","resolution":"Templates must have unique name and language. Change language or name and submit again.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_exists-1","summary":"TemplateExistsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_exists-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_name_recently_used-2":{"value":{"errorCode":"template_name_recently_used","message":"A template with the same name has been deleted within 30 days.","resolution":"Use another \"name\" for \"EN\" or wait the required time."},"key":"template_name_recently_used-2","summary":"TemplateNameRecentlyUsedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_name_recently_used-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_incorrect_category-3":{"value":{"errorCode":"template_incorrect_category","message":"Template incorrect category.","resolution":"Use a category that has been used in another language: \"UTILITY\"."},"key":"template_incorrect_category-3","summary":"TemplateIncorrectCategoryError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_incorrect_category-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-4":{"value":{"errorCode":"template_restricted_Domain_for_button_url","message":"Restricted domain for button url.","resolution":"Replace any of the following restricted domains: wa.me, whatsapp.com"},"key":"template_restricted_Domain_for_button_url-4","summary":"TemplateRestrictedDomainForButtonUrlError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_not_found-5":{"value":{"errorCode":"file_not_found","message":"details.components[0].headerExample.media.url: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-5","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_not_found-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_size_too_large-6":{"value":{"errorCode":"file_size_too_large","message":"details.components[0].headerExample.media.url: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 5MB."},"key":"file_size_too_large-6","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_size_too_large-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_unexpected_error-7":{"value":{"errorCode":"file_unexpected_error","message":"details.components[0].headerExample.media.url: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-7","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/file_unexpected_error-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-8":{"value":{"errorCode":"object_with_whatsapp_business_account_id_does_not_exist","message":"WhatsApp Business Account does not exist.","resolution":"Verify that WhatsApp Business ID still exists and contact support."},"key":"object_with_whatsapp_business_account_id_does_not_exist-8","summary":"ObjectWithWhatsappBusinessAccountIdDoesNotExistError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-8"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_language_recently_deleted-9":{"value":{"errorCode":"template_language_recently_deleted","message":"A template with the same language has been deleted within 4 weeks.","resolution":"Try to create EN content again in 4 weeks or create a new template."},"key":"template_language_recently_deleted-9","summary":"TemplateLanguageRecentlyDeletedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/409/content/application~1json/examples/template_language_recently_deleted-9"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_limit_reached-0":{"value":{"errorCode":"template_limit_reached","message":"Number of templates has reached the limit.","resolution":"Delete some templates or reach out to support to increase the template limit. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_limit_reached-0","summary":"TemplateLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_content_already_exists-1":{"value":{"errorCode":"template_content_already_exists","message":"Template cannot be submitted because the content is the same as the content in another template.","resolution":"Use other template or edit template data and submit again. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_content_already_exists-1","summary":"TemplateContentAlreadyExistsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_content_already_exists-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_submit_error-2":{"value":{"errorCode":"template_submit_error","message":"Template submit error.","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{"metaError":{"code":"123","subcode":"123456","message":"Invalid parameter","description":"Character Limit Exceeded","reason":"field 'name' can't have more than 1,024 characters"}}},"key":"template_submit_error-2","summary":"TemplateSubmitErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/424/content/application~1json/examples/template_submit_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0":{"value":{"errorCode":"whatsapp_business_api_request_limit_exceeded","message":"WhatsApp business api request limit reached.","resolution":"WhatsApp business API request limits reached. Please try again later."},"key":"whatsapp_business_api_request_limit_exceeded-0","summary":"WhatsappBusinessApiRequestLimitExceededError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0":{"value":{"errorCode":"template_start_session_for_uploading_media","message":"Failed to start session for uploading template media example.","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_start_session_for_uploading_media-0","summary":"TemplateStartSessionForUploadingMediaError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-2":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-2","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/responses/500/content/application~1json/examples/internal_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_COMMENT_ADDED","payload":{"name":"My WhatsApp Template","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","changes":{"status":"DRAFT","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"HEADER","format":"DOCUMENT","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"HEADER","format":"LOCATION"},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true},{"type":"FOOTER","text":"To track your order please click the 'Track Your Order' button","codeExpirationMinutes":5},{"type":"BUTTONS","buttons":[{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"},{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"OTP","otpType":"COPY_CODE","text":"Example text."},{"type":"REQUEST_CONTACT_INFO","text":"Share Contact Info"},{"type":"ORDER_DETAILS","text":"Copy Pix code"},{"type":"COPY_CODE","text":"Copy offer code","examples":["WINTER27"]}]},{"type":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"]},{"type":"BUTTONS","buttons":[{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"}]}]}]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_APPROVED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_REJECTED","payload":{"name":"My WhatsApp Template","state":"REJECTED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_STATUS_UPDATED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"PAUSED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false},"newState":"PAUSED"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_DELETED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/Deleted/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false},"futureCategory":"MARKETING"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates/post/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_token-2":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-2","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_page_token-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_fields-3":{"value":{"errorCode":"invalid_fields","message":"Invalid fields.","resolution":"Verify that the fields used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"whatsappId, state, name, language, category, rejectionCode, qualityScore, changes, changes.status, changes.allowCategoryChange, changes.details, changes.details.components, changes.details.components.0.type, changes.details.components.0.format, changes.details.components.0.text, changes.details.components.0.example, changes.details.components.0.example.url, changes.details.components.0.examples, changes.details.components.0.addSecurityRecommendation, changes.details.components.0.codeExpirationMinutes, changes.details.components.0.buttons, changes.details.components.0.buttons.0.type, changes.details.components.0.buttons.0.text, changes.details.components.0.buttons.0.phoneNumber, changes.details.components.0.buttons.0.url, changes.details.components.0.buttons.0.example, changes.details.components.0.buttons.0.otpType, changes.details.components.0.buttons.0.autofillText, changes.details.components.0.buttons.0.packageName, changes.details.components.0.buttons.0.signatureHash, changes.details.components.0.buttons.0.supportedApps, changes.details.components.0.buttons.0.supportedApps.0.packageName, changes.details.components.0.buttons.0.supportedApps.0.signatureHash, changes.details.components.0.buttons.0.zeroTapTermsAccepted, changes.details.components.0.buttons.0.flowId, changes.details.components.0.buttons.0.flowAction, changes.details.components.0.buttons.0.navigateScreen, changes.details.components.0.hasExpiration, changes.details.messageSendTtlSeconds, changes.details.optimization, details, details.components, details.components.0.type, details.components.0.format, details.components.0.text, details.components.0.example, details.components.0.example.url, details.components.0.examples, details.components.0.addSecurityRecommendation, details.components.0.codeExpirationMinutes, details.components.0.buttons, details.components.0.buttons.0.type, details.components.0.buttons.0.text, details.components.0.buttons.0.phoneNumber, details.components.0.buttons.0.url, details.components.0.buttons.0.example, details.components.0.buttons.0.otpType, details.components.0.buttons.0.autofillText, details.components.0.buttons.0.packageName, details.components.0.buttons.0.signatureHash, details.components.0.buttons.0.supportedApps, details.components.0.buttons.0.supportedApps.0.packageName, details.components.0.buttons.0.supportedApps.0.signatureHash, details.components.0.buttons.0.zeroTapTermsAccepted, details.components.0.buttons.0.flowId, details.components.0.buttons.0.flowAction, details.components.0.buttons.0.navigateScreen, details.components.0.hasExpiration, details.messageSendTtlSeconds, details.optimization, analytics, analytics.0.sent, analytics.0.delivered, analytics.0.read, analytics.0.start, analytics.0.end, analytics.0.buttons, analytics.0.buttons.0.type, analytics.0.buttons.0.content, analytics.0.buttons.0.clicks, isMetaGenerated"}},"key":"invalid_fields-3","summary":"InvalidFieldsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/400/content/application~1json/examples/invalid_fields-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-1","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0":{"value":{"errorCode":"whatsapp_business_api_request_limit_exceeded","message":"WhatsApp business api request limit reached.","resolution":"WhatsApp business API request limits reached. Please try again later."},"key":"whatsapp_business_api_request_limit_exceeded-0","summary":"WhatsappBusinessApiRequestLimitExceededError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/template_invalid_language_code-1":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-1","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/template_invalid_language_code-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/invalid_fields-2":{"value":{"errorCode":"invalid_fields","message":"Invalid fields.","resolution":"Verify that the fields used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"whatsappId, state, name, language, category, rejectionCode, qualityScore, changes, changes.status, changes.allowCategoryChange, changes.details, changes.details.components, changes.details.components.0.type, changes.details.components.0.format, changes.details.components.0.text, changes.details.components.0.example, changes.details.components.0.example.url, changes.details.components.0.examples, changes.details.components.0.addSecurityRecommendation, changes.details.components.0.codeExpirationMinutes, changes.details.components.0.buttons, changes.details.components.0.buttons.0.type, changes.details.components.0.buttons.0.text, changes.details.components.0.buttons.0.phoneNumber, changes.details.components.0.buttons.0.url, changes.details.components.0.buttons.0.example, changes.details.components.0.buttons.0.otpType, changes.details.components.0.buttons.0.autofillText, changes.details.components.0.buttons.0.packageName, changes.details.components.0.buttons.0.signatureHash, changes.details.components.0.buttons.0.supportedApps, changes.details.components.0.buttons.0.supportedApps.0.packageName, changes.details.components.0.buttons.0.supportedApps.0.signatureHash, changes.details.components.0.buttons.0.zeroTapTermsAccepted, changes.details.components.0.buttons.0.flowId, changes.details.components.0.buttons.0.flowAction, changes.details.components.0.buttons.0.navigateScreen, changes.details.components.0.hasExpiration, changes.details.messageSendTtlSeconds, changes.details.optimization, details, details.components, details.components.0.type, details.components.0.format, details.components.0.text, details.components.0.example, details.components.0.example.url, details.components.0.examples, details.components.0.addSecurityRecommendation, details.components.0.codeExpirationMinutes, details.components.0.buttons, details.components.0.buttons.0.type, details.components.0.buttons.0.text, details.components.0.buttons.0.phoneNumber, details.components.0.buttons.0.url, details.components.0.buttons.0.example, details.components.0.buttons.0.otpType, details.components.0.buttons.0.autofillText, details.components.0.buttons.0.packageName, details.components.0.buttons.0.signatureHash, details.components.0.buttons.0.supportedApps, details.components.0.buttons.0.supportedApps.0.packageName, details.components.0.buttons.0.supportedApps.0.signatureHash, details.components.0.buttons.0.zeroTapTermsAccepted, details.components.0.buttons.0.flowId, details.components.0.buttons.0.flowAction, details.components.0.buttons.0.navigateScreen, details.components.0.hasExpiration, details.messageSendTtlSeconds, details.optimization, analytics, analytics.0.sent, analytics.0.delivered, analytics.0.read, analytics.0.start, analytics.0.end, analytics.0.buttons, analytics.0.buttons.0.type, analytics.0.buttons.0.content, analytics.0.buttons.0.clicks, isMetaGenerated"}},"key":"invalid_fields-2","summary":"InvalidFieldsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/400/content/application~1json/examples/invalid_fields-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-1","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/400/content/application~1json/examples/template_invalid_language_code-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_changes_not_found-1":{"value":{"errorCode":"template_changes_not_found","message":"Template changes not found.","resolution":"Verify that the template has pending changes."},"key":"template_changes_not_found-1","summary":"TemplateChangesNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/404/content/application~1json/examples/template_changes_not_found-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/template_not_deletable_due_to_input_config-1":{"value":{"errorCode":"template_not_deletable_due_to_input_config","message":"Template is not deletable due to input config.","resolution":"Only draft templates will be deleted by name and language code if `deleteSubmitted` is `false` or not provided. Be aware that templates deleted for a language cannot be recreated for 30 days with the same template name. If you need the template in this language soon, update the submitted template for the language instead of trying to delete and recreate it again."},"key":"template_not_deletable_due_to_input_config-1","summary":"TemplateNotDeletableDueToInputConfigError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/409/content/application~1json/examples/template_not_deletable_due_to_input_config-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value":{"value":{"details":{"components":[{"type":"HEADER","format":"LOCATION"},{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"HEADER","format":"DOCUMENT","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true},{"type":"FOOTER","text":"To track your order please click the 'Track Your Order' button","codeExpirationMinutes":5},{"type":"BUTTONS","buttons":[{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"},{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"OTP","otpType":"COPY_CODE","text":"Example text."},{"type":"FLOW","text":"Start Flow","flowId":"flow-id","navigateScreen":"QUESTION_ONE","flowAction":"NAVIGATE"},{"type":"REQUEST_CONTACT_INFO"},{"type":"ORDER_DETAILS"},{"type":"COPY_CODE","examples":["WINTER27"]}]},{"type":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"]},{"type":"BUTTONS","buttons":[{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"}]}]}]}],"messageSendTtlSeconds":60}},"key":"value","summary":"Body request","description":"\n      Example body request to update a template.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/value"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization":{"value":{"status":"DRAFT","category":"MARKETING","details":{"optimization":{"bidAmount":10,"bidStrategy":"LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.0","GB":"2.8"}}}},"key":"marketingWithOptimization","summary":"Marketing template update with dynamic pricing optimization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the dynamic pricing optimization for an existing Marketing template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic pricing is available only for direct-business accounts whose WABA is enabled for maximum-price templates, is connected to a Business Manager, and has the Marketing API enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.optimization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to leave the existing optimization unchanged."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithOptimization"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization":{"value":{"status":"DRAFT","category":"MARKETING","details":{"optimization":null}},"key":"marketingWithoutOptimization","summary":"Remove dynamic pricing optimization from a Marketing template","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes the dynamic pricing optimization from an existing Marketing template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.optimization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear the existing optimization."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutOptimization"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides":{"value":{"status":"DRAFT","category":"MARKETING","details":{"optimization":{"bidAmount":10,"bidStrategy":"LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":null}}},"key":"marketingWithoutCountryMultiplierOverrides","summary":"Clear country multiplier overrides from a Marketing template","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clears the country-specific bid multiplier overrides while keeping dynamic pricing optimization enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.optimization.bidCountryMultiplierOverrides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear the existing overrides."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/requestBody/content/application~1json/examples/marketingWithoutCountryMultiplierOverrides"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/200/content/application~1json/examples/response":{"value":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","changes":{"status":"IN_PROGRESS","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"HEADER","format":"DOCUMENT","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"HEADER","format":"LOCATION"},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true},{"type":"FOOTER","text":"To track your order please click the 'Track Your Order' button","codeExpirationMinutes":5},{"type":"BUTTONS","buttons":[{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"},{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"OTP","otpType":"COPY_CODE","text":"Example text."},{"type":"REQUEST_CONTACT_INFO","text":"Share Contact Info"},{"type":"ORDER_DETAILS","text":"Copy Pix code"},{"type":"COPY_CODE","text":"Copy offer code","examples":["WINTER27"]}]},{"type":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"]},{"type":"BUTTONS","buttons":[{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"}]}]}]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}}},"details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false},"key":"response","summary":"Update response","description":"\n    Response when successfully update a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_language_code-1":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-1","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_language_code-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_policies_violations-2":{"value":{"errorCode":"template_policies_violations","message":"Your message couldn't be sent because it includes content that other people on Facebook have reported as abusive.","resolution":"Remove violating content. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_policies_violations-2","summary":"TemplatePoliciesViolationsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_policies_violations-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_check_media_file_size-3":{"value":{"errorCode":"template_check_media_file_size","message":"Failed to check media file size.","resolution":"Ensure media file URL is correct and then try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_check_media_file_size-3","summary":"TemplateCheckMediaFileSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_check_media_file_size-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_button_example-4":{"value":{"errorCode":"template_invalid_button_example","message":"Invalid button example.","resolution":"Only dynamic URL buttons are allowed to have an example."},"key":"template_invalid_button_example-4","summary":"TemplateInvalidButtonExampleError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_invalid_button_example-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-5":{"value":{"errorCode":"template_media_file_size_exceeds_maximum_file_size_limit","message":"Template media file size exceeds maximum file size limit.","resolution":"Try again with a smaller file."},"key":"template_media_file_size_exceeds_maximum_file_size_limit-5","summary":"TemplateMediaFileSizeExceedsMaximumFileSizeLimitError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/template_media_file_size_exceeds_maximum_file_size_limit-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-6":{"value":{"errorCode":"file_invalid_mime_type","message":"details.components[0].headerExample.media.url: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png, application/pdf, video/3gp, video/mp4."},"key":"file_invalid_mime_type-6","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/invalid_payload-7":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-7","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/400/content/application~1json/examples/invalid_payload-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1":{"value":{"errorCode":"template_not_updatable","message":"Template is not updatable.","resolution":"Updates are only supported by templates with state: APPROVED, DISABLED, PAUSED, REJECTED."},"key":"template_not_updatable-1","summary":"TemplateNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2":{"value":{"errorCode":"template_changes_not_updatable","message":"Template is not updatable.","resolution":"Updates are only supported by template changes with status: DRAFT, REJECTED."},"key":"template_changes_not_updatable-2","summary":"TemplateChangesNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_category_not_updatable-3":{"value":{"errorCode":"template_category_not_updatable","message":"Template category is not updatable.","resolution":"Updates are only supported by template with state: DRAFT or with state: REJECTED and rejectionCode: INCORRECT_CATEGORY."},"key":"template_category_not_updatable-3","summary":"TemplateCategoryNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_category_not_updatable-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_allow_category_change_not_updatable-4":{"value":{"errorCode":"template_allow_category_change_not_updatable","message":"Template allowCategoryChange is not updatable.","resolution":"Updates are only supported by template with state: DRAFT or with state: REJECTED and rejectionCode: INCORRECT_CATEGORY."},"key":"template_allow_category_change_not_updatable-4","summary":"TemplateAllowCategoryChangeNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_allow_category_change_not_updatable-4"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_source_not_updatable-5":{"value":{"errorCode":"template_source_not_updatable","message":"Template is not updatable.","resolution":"Templates generated by Meta cannot be updated."},"key":"template_source_not_updatable-5","summary":"TemplateSourceNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_source_not_updatable-5"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_name_recently_used-6":{"value":{"errorCode":"template_name_recently_used","message":"A template with the same name has been deleted within 30 days.","resolution":"Use another \"name\" for \"EN\" or wait the required time."},"key":"template_name_recently_used-6","summary":"TemplateNameRecentlyUsedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_name_recently_used-6"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-7":{"value":{"errorCode":"template_restricted_Domain_for_button_url","message":"Restricted domain for button url.","resolution":"Replace any of the following restricted domains: wa.me, whatsapp.com"},"key":"template_restricted_Domain_for_button_url-7","summary":"TemplateRestrictedDomainForButtonUrlError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_restricted_Domain_for_button_url-7"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_not_found-8":{"value":{"errorCode":"file_not_found","message":"details.components[0].headerExample.media.url: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-8","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_not_found-8"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_size_too_large-9":{"value":{"errorCode":"file_size_too_large","message":"details.components[0].headerExample.media.url: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 5MB."},"key":"file_size_too_large-9","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_size_too_large-9"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_unexpected_error-10":{"value":{"errorCode":"file_unexpected_error","message":"details.components[0].headerExample.media.url: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-10","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/file_unexpected_error-10"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-11":{"value":{"errorCode":"object_with_whatsapp_business_account_id_does_not_exist","message":"WhatsApp Business Account does not exist.","resolution":"Verify that WhatsApp Business ID still exists and contact support."},"key":"object_with_whatsapp_business_account_id_does_not_exist-11","summary":"ObjectWithWhatsappBusinessAccountIdDoesNotExistError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/object_with_whatsapp_business_account_id_does_not_exist-11"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_language_recently_deleted-12":{"value":{"errorCode":"template_language_recently_deleted","message":"A template with the same language has been deleted within 4 weeks.","resolution":"Try to create EN content again in 4 weeks or create a new template."},"key":"template_language_recently_deleted-12","summary":"TemplateLanguageRecentlyDeletedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/409/content/application~1json/examples/template_language_recently_deleted-12"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_limit_reached-0":{"value":{"errorCode":"template_limit_reached","message":"Number of templates has reached the limit.","resolution":"Delete some templates or reach out to support to increase the template limit. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_limit_reached-0","summary":"TemplateLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_content_already_exists-1":{"value":{"errorCode":"template_content_already_exists","message":"Template cannot be submitted because the content is the same as the content in another template.","resolution":"Use other template or edit template data and submit again. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_content_already_exists-1","summary":"TemplateContentAlreadyExistsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_content_already_exists-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_submit_error-2":{"value":{"errorCode":"template_submit_error","message":"Template submit error.","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{"metaError":{"code":"123","subcode":"123456","message":"Invalid parameter","description":"Character Limit Exceeded","reason":"field 'name' can't have more than 1,024 characters"}}},"key":"template_submit_error-2","summary":"TemplateSubmitErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/424/content/application~1json/examples/template_submit_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0":{"value":{"errorCode":"whatsapp_business_api_request_limit_exceeded","message":"WhatsApp business api request limit reached.","resolution":"WhatsApp business API request limits reached. Please try again later."},"key":"whatsapp_business_api_request_limit_exceeded-0","summary":"WhatsappBusinessApiRequestLimitExceededError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/429/content/application~1json/examples/whatsapp_business_api_request_limit_exceeded-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0":{"value":{"errorCode":"template_start_session_for_uploading_media","message":"Failed to start session for uploading template media example.","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"template_start_session_for_uploading_media-0","summary":"TemplateStartSessionForUploadingMediaError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/template_start_session_for_uploading_media-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-2":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-2","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/responses/500/content/application~1json/examples/internal_error-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_COMMENT_ADDED","payload":{"name":"My WhatsApp Template","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","changes":{"status":"DRAFT","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]},{"type":"HEADER","format":"DOCUMENT","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"HEADER","format":"LOCATION"},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"],"addSecurityRecommendation":true},{"type":"FOOTER","text":"To track your order please click the 'Track Your Order' button","codeExpirationMinutes":5},{"type":"BUTTONS","buttons":[{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"},{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"OTP","otpType":"COPY_CODE","text":"Example text."},{"type":"REQUEST_CONTACT_INFO","text":"Share Contact Info"},{"type":"ORDER_DETAILS","text":"Copy Pix code"},{"type":"COPY_CODE","text":"Copy offer code","examples":["WINTER27"]}]},{"type":"CAROUSEL","cards":[{"components":[{"type":"HEADER","format":"IMAGE","examples":[{"url":"https://example.com/photos/1.png"}]},{"type":"BODY","text":"Good morning {{1}}, your package has arrived.","examples":["Mr. Smith"]},{"type":"BUTTONS","buttons":[{"type":"URL","text":"Example test","url":"https://www.my-website.com?name={{1}}","examples":["https://www.my-website.com?name=john"]},{"type":"QUICK_REPLY","text":"Track Your Order"},{"type":"PHONE_NUMBER","text":"Example text.","phoneNumber":"+48 777 777777"}]}]}]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_APPROVED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Approved/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_REJECTED","payload":{"name":"My WhatsApp Template","state":"REJECTED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_STATUS_UPDATED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"PAUSED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false},"newState":"PAUSED"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/StatusUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_DELETED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/Deleted/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/QualityScoreUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_CATEGORY_UPDATED","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false}},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/CategoryUpdated/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example":{"value":{"type":"WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE","payload":{"whatsappId":"123456","name":"My WhatsApp Template","state":"APPROVED","category":"UTILITY","language":"EN_US","qualityScore":"QUALITY_SCORE_GREEN","details":{"components":[{"type":"HEADER","format":"TEXT","text":"Save {{1}}% on your next purchase!","examples":["20"]}],"messageSendTtlSeconds":60,"optimization":{"bidAmount":500,"bidStrategy":"BID_STRATEGY_LOWEST_COST_WITH_BID_CAP","bidCountryMultiplierOverrides":{"US":"1.2","GB":"1.1"}}},"analytics":[],"isMetaGenerated":false},"futureCategory":"MARKETING"},"id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}/patch/callbacks/FutureCategoryUpdate/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-01-19T13:11:08.204Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-01-19T13:11:08.204Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List template activities response","description":"\n    Response for all template activities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/template_invalid_language_code-1":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-1","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/template_invalid_language_code-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-2":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-2","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-3":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-3","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n      Example body request to create a comment.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n    Response when successfully creating a comment.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["comment must be longer than or equal to 1 characters"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-2","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-3","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input":{"value":{"templates":[{"templateName":"templateName2","templateLanguage":"PL"}],"timeframe":"60","endTimestamp":1694612898734},"key":"input","summary":"Body request","description":"\n      Example body request compare templates.\n      ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/200/content/application~1json/examples/created":{"value":{"templates":[{"name":"templateName1","language":"EN","blockOrder":1,"messageSends":1000,"topBlockReason":"NO_REASON"},{"name":"templateName1","language":"PL","blockOrder":2,"messageSends":2000,"topBlockReason":"NO_REASON_GIVEN"}]},"key":"created","summary":"Compare template response","description":"\n    Response when successfully compared templates.\n    ","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/200/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["templates must be an array","templates must contain no more than 1 elements","templates must contain at least 1 elements"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/template_invalid_language_code-2":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and WhatsApp.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ES_UY, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-2","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/template_invalid_language_code-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_payload-3":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-3","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/400/content/application~1json/examples/invalid_payload-3"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/templates_compare_not_found-1":{"value":{"errorCode":"templates_compare_not_found","message":"Templates to compare not found.","resolution":"Verify that the parameters are correct. No templates found for templateName: templateName and templateLanguage: EN"},"key":"templates_compare_not_found-1","summary":"TemplatesCompareNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/404/content/application~1json/examples/templates_compare_not_found-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_not_eligible_for_comparison-1":{"value":{"errorCode":"templates_not_eligible_for_comparison","message":"Templates not eligible for comparison.","resolution":"Templates must have been sent at least 1,000 times in the specified timeframe."},"key":"templates_not_eligible_for_comparison-1","summary":"TemplatesNotEligibleForComparisonError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_not_eligible_for_comparison-1"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_compare_not_unique-2":{"value":{"errorCode":"templates_compare_not_unique","message":"Templates to compare not unique.","resolution":"Template can't be compared with itself. Provide unique templates for comparison."},"key":"templates_compare_not_unique-2","summary":"TemplatesCompareNotUniqueError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/409/content/application~1json/examples/templates_compare_not_unique-2"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1{templateName}~1languages~1{languageCode}~1compare/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for WhatsApp.","resolution":"Verify that the project ID is correct and that it has been onboarded for WhatsApp."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/409/content/application~1json/examples/resource_locked-0":{"value":{"errorCode":"resource_locked","message":"Resource is locked.","resolution":"Another operation for this resource is already in progress. Please wait and try again."},"key":"resource_locked-0","summary":"ResourceLockedError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/409/content/application~1json/examples/resource_locked-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/429/content/application~1json/examples/too_many_requests-0":{"value":{"errorCode":"too_many_requests","message":"Too many requests.","resolution":"Please wait and try again."},"key":"too_many_requests-0","summary":"TooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/429/content/application~1json/examples/too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1whatsapp~1templates~1sync/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":1,"pageSize":10,"bundles":[{"id":"62a02dd40000000000000000","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","region":"US","subproject":{"id":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","parentProjectId":"18bbdcc8-117d-42f0-85cc-e30462c49404","status":"PENDING"},"smsApp":{"id":"54e5eb6cae6242c88c132c8da8bb1072","smsServiceId":"d84b09da00fb4b76ff63f2fcea8d46c7","name":"Sample response","status":"PENDING_ADD","regions":["US"],"test":false},"convApp":{"id":"31c12b1042d14b37ae96df96bb13575b","name":"Sample response","processingMode":"CONVERSATION"},"webhooks":[{"id":"7c60ce550f1d40198d5ffb113d58591b","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","triggers":["BUNDLE_DONE"]}],"state":"IN_PROGRESS"},{"id":"55402ee30230777000098701","projectId":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","name":"Bundle name","region":"US","subproject":{"id":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","name":"Subproject name","parentProjectId":"8c9148fa-8f4e-46f6-8229-565ce0f527be","status":"READY"},"smsApp":{"id":"64efff6cae6242c88cfee38da8bb8976","smsServiceId":"566544da00fb4b769008f2fcea9067e3","name":"SMS App name","status":"ACTIVE","regions":["US"],"test":false},"convApp":{"id":"aa252b10e5614b37ff96df96bb560092","name":"Conversation App name","processingMode":"CONVERSATION"},"webhooks":[{"id":"9981ce550f1dfea0005ffb113d581434","projectId":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","target":"https://webhook.site/de85df25-f474-4997-b50d-264955e3cedb","triggers":["BUNDLE_DONE"]}],"state":"DONE","webhookDeliveryStatuses":[{"webhookId":"9981ce550f1dfea0005ffb113d581434","date":"2026-06-24T11:54:15.123Z","httpStatusCode":200}]}]},"key":"response","summary":"List response","description":"\n    Response with sms apps.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_id_format-2":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"projectId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-2","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/400/content/application~1json/examples/invalid_id_format-2"},"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1bundles/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small":{"value":{"name":"Small bundle example","region":"US","subproject":true,"smsApp":true,"convApp":{"name":"Conversation App Example","webhooks":[{"target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","secret":"secret","triggers":["MESSAGE_DELIVERY"]}],"processingMode":"DISPATCH","retentionPolicy":{"retentionPolicyType":"MESSAGE_EXPIRE_POLICY","ttl":7},"consentManagerSettings":{"mode":"PRIMARY"}},"webhooks":[{"target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","secret":"secret","triggers":["BUNDLE_DONE"]}]},"key":"small","summary":"Small example","description":"\n    Small example to create a subproject, SMS App and Conversation App. The webhooks for Conversation API and Provisioning API are examples and can be extended.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/small"},"paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal":{"value":{"name":"Minimal bundle example","region":"US","subproject":true,"smsApp":true,"convApp":true},"key":"minimal","summary":"Minimal example","description":"\n    Minimal example to create a subproject, SMS App and Conversation App. This will not register any webhooks which will have to be done separately.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/minimal"},"paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full":{"value":{"name":"Full bundle example","region":"US","subproject":{"name":"Subproject Example","labels":{"env":"testing","team":"QA-team"}},"smsApp":{"name":"Sms App Example"},"convApp":{"name":"Conversation App Example","webhooks":[{"target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","secret":"secret","triggers":["MESSAGE_DELIVERY"]}],"processingMode":"DISPATCH","retentionPolicy":{"retentionPolicyType":"MESSAGE_EXPIRE_POLICY","ttl":7},"consentManagerSettings":{"mode":"PRIMARY"}},"webhooks":[{"target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","secret":"secret","triggers":["BUNDLE_DONE"]}],"testNumber":true},"key":"full","summary":"Full example","description":"\n    Full example with all options filled in. The webhooks for Conversation API and Provisioning API are examples and can be extended.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/requestBody/content/application~1json/examples/full"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/notReady":{"value":{"id":"62a02dd40000000000000000","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","region":"US","subproject":{"id":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","parentProjectId":"18bbdcc8-117d-42f0-85cc-e30462c49404","status":"PENDING"},"smsApp":{"id":"54e5eb6cae6242c88c132c8da8bb1072","smsServiceId":"d84b09da00fb4b76ff63f2fcea8d46c7","name":"Sample response","status":"PENDING_ADD","regions":["US"],"test":false},"convApp":{"id":"31c12b1042d14b37ae96df96bb13575b","name":"Sample response","processingMode":"CONVERSATION"},"webhooks":[{"id":"7c60ce550f1d40198d5ffb113d58591b","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","triggers":["BUNDLE_DONE"]}],"state":"IN_PROGRESS"},"key":"notReady","summary":"Pending response","description":"\n    Response if the SMS App is not ready. This is the most likely response.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/notReady"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/ready":{"value":{"id":"55402ee30230777000098701","projectId":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","name":"Bundle name","region":"US","subproject":{"id":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","name":"Subproject name","parentProjectId":"8c9148fa-8f4e-46f6-8229-565ce0f527be","status":"READY"},"smsApp":{"id":"64efff6cae6242c88cfee38da8bb8976","smsServiceId":"566544da00fb4b769008f2fcea9067e3","name":"SMS App name","status":"ACTIVE","regions":["US"],"test":false},"convApp":{"id":"aa252b10e5614b37ff96df96bb560092","name":"Conversation App name","processingMode":"CONVERSATION"},"webhooks":[{"id":"9981ce550f1dfea0005ffb113d581434","projectId":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","target":"https://webhook.site/de85df25-f474-4997-b50d-264955e3cedb","triggers":["BUNDLE_DONE"]}],"state":"DONE","webhookDeliveryStatuses":[{"webhookId":"9981ce550f1dfea0005ffb113d581434","date":"2026-06-24T11:54:15.123Z","httpStatusCode":200}]},"key":"ready","summary":"Completed response","description":"\n    Response if the SMS App is ready. The data is the same as the callback payload.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/201/content/application~1json/examples/ready"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["subproject must be boolean or object"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/no_services_to_create-2":{"value":{"errorCode":"no_services_to_create","message":"No services to create.","resolution":"Add at least one service to create."},"key":"no_services_to_create-2","summary":"NoServicesToCreateError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/no_services_to_create-2"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/missing_name-3":{"value":{"errorCode":"missing_name","message":"Missing name for bundles.","resolution":"Make sure you have given a separate service name or principal."},"key":"missing_name-3","summary":"MissingNameError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/missing_name-3"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_webhooks-4":{"value":{"errorCode":"invalid_webhooks","message":"Unable to create webhooks.","resolution":"Please try again."},"key":"invalid_webhooks-4","summary":"InvalidWebhooksError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_webhooks-4"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_staging_bundles_input_region-5":{"value":{"errorCode":"invalid_staging_bundles_input_region","message":"Invalid bundles region for staging.","resolution":"Verify that bundles region is valid for staging. Allowed bundles regions for staging EU, US."},"key":"invalid_staging_bundles_input_region-5","summary":"InvalidStagingBundlesInputRegionError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/invalid_staging_bundles_input_region-5"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_bespoke_price-6":{"value":{"errorCode":"parent_sms_bespoke_price","message":"Parent SMS service has bespoke pricing.","resolution":"SMS apps cannot be copied from a parent project that has bespoke pricing configured."},"key":"parent_sms_bespoke_price-6","summary":"ParentSmsBespokePriceError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_bespoke_price-6"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/target_project_not_subproject-7":{"value":{"errorCode":"target_project_not_subproject","message":"Target project is not a subproject.","resolution":"Copying an SMS app from a parent is only supported when the target project is a subproject."},"key":"target_project_not_subproject-7","summary":"TargetProjectNotSubprojectError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/target_project_not_subproject-7"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_not_route_assisted-8":{"value":{"errorCode":"parent_sms_not_route_assisted","message":"Parent SMS service is not route assisted.","resolution":"SMS apps can only be copied from a parent project whose SMS service is route assisted."},"key":"parent_sms_not_route_assisted-8","summary":"ParentSmsNotRouteAssistedError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/parent_sms_not_route_assisted-8"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/conversation_app_already_connected_to_sms_app-9":{"value":{"errorCode":"conversation_app_already_connected_to_sms_app","message":"Conversation App is already connected to an SMS App.","resolution":"Use the SMS App that is already connected to the Conversation App or disconnect the currently connected SMS App before connecting another SMS App."},"key":"conversation_app_already_connected_to_sms_app-9","summary":"ConversationAppAlreadyConnectedToSmsAppError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/400/content/application~1json/examples/conversation_app_already_connected_to_sms_app-9"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/403/content/application~1json/examples/forbidden_payload-0":{"value":{"errorCode":"forbidden_payload","message":"Forbidden payload.","resolution":"Please ensure that you have permission to use that payload."},"key":"forbidden_payload-0","summary":"ForbiddenPayloadError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/403/content/application~1json/examples/forbidden_payload-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/conversation_app_not_found-0":{"value":{"errorCode":"conversation_app_not_found","message":"Conversation App not found.","resolution":"Verify that the appId is correct."},"key":"conversation_app_not_found-0","summary":"ConversationAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/conversation_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/sms_app_not_found-1":{"value":{"errorCode":"sms_app_not_found","message":"SmsApp not found.","resolution":"Verify that the appId is correct."},"key":"sms_app_not_found-1","summary":"SmsAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/sms_app_not_found-1"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/default_sms_app_not_found-2":{"value":{"errorCode":"default_sms_app_not_found","message":"Default SmsApp not found.","resolution":"Create SmsApp in test mode to use in request."},"key":"default_sms_app_not_found-2","summary":"DefaultSmsAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/404/content/application~1json/examples/default_sms_app_not_found-2"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/webhook_exists-0":{"value":{"errorCode":"webhook_exists","message":"Webhook with the provided target already exists.","resolution":"Webhooks must have a unique target. Change the target and submit again."},"key":"webhook_exists-0","summary":"WebhookExistsError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/webhook_exists-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/conversation_app_is_already_in_bundles_process-1":{"value":{"errorCode":"conversation_app_is_already_in_bundles_process","message":"Conversation App is already in Bundles process.","resolution":"Please select another conversationAppId for which the request is to be made."},"key":"conversation_app_is_already_in_bundles_process-1","summary":"ConversationAppIsAlreadyInBundlesProcessError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/conversation_app_is_already_in_bundles_process-1"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/default_sms_app_already_exists-2":{"value":{"errorCode":"default_sms_app_already_exists","message":"Default SmsApp already exists.","resolution":"Please contact with support."},"key":"default_sms_app_already_exists-2","summary":"DefaultSmsAppAlreadyExistsError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/default_sms_app_already_exists-2"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/more_than_one_sms_app-3":{"value":{"errorCode":"more_than_one_sms_app","message":"More than one SmsApp.","resolution":"Please select the smsAppId for which the request is to be made."},"key":"more_than_one_sms_app-3","summary":"MoreThanOneSmsAppError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/more_than_one_sms_app-3"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_linked_to_conversation_app-4":{"value":{"errorCode":"sms_app_is_already_linked_to_conversation_app","message":"SmsApp is already linked to ConversationApp.","resolution":"Please select another smsAppId for which the request is to be made."},"key":"sms_app_is_already_linked_to_conversation_app-4","summary":"SmsAppIsAlreadyLinkedToConversationAppError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_linked_to_conversation_app-4"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_in_bundles_process-5":{"value":{"errorCode":"sms_app_is_already_in_bundles_process","message":"SmsApp is already in Bundles process.","resolution":"Please select another smsAppId for which the request is to be made."},"key":"sms_app_is_already_in_bundles_process-5","summary":"SmsAppIsAlreadyInBundlesProcessError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/sms_app_is_already_in_bundles_process-5"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/allowed_only_for_default_test_sms_app-6":{"value":{"errorCode":"allowed_only_for_default_test_sms_app","message":"Allowed only for default test SMS app.","resolution":"Verify that the SMS app is marked as defaultTest."},"key":"allowed_only_for_default_test_sms_app-6","summary":"AllowedOnlyForDefaultTestSmsAppError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/allowed_only_for_default_test_sms_app-6"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_subproject-7":{"value":{"errorCode":"not_allowed_for_subproject","message":"Not allowed for subproject.","resolution":"Verify that the subproject is eligible for test numbers."},"key":"not_allowed_for_subproject-7","summary":"NotAllowedForSubprojectError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_subproject-7"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_non_test_account-8":{"value":{"errorCode":"not_allowed_for_non_test_account","message":"Not allowed for non test account.","resolution":"Verify that the account is a test account."},"key":"not_allowed_for_non_test_account-8","summary":"NotAllowedForNonTestAccountError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/not_allowed_for_non_test_account-8"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/only_one_test_number_allowed-9":{"value":{"errorCode":"only_one_test_number_allowed","message":"Only one active test number is allowed per project.","resolution":"Verify that there are no other active test numbers in the project."},"key":"only_one_test_number_allowed-9","summary":"OnlyOneTestNumberAllowedError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/409/content/application~1json/examples/only_one_test_number_allowed-9"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/424/content/application~1json/examples/webhook_limit_reached-0":{"value":{"errorCode":"webhook_limit_reached","message":"Number of webhooks has reached the limit.","resolution":"Delete some webhooks to be able to add more."},"key":"webhook_limit_reached-0","summary":"WebhookLimitReachedError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/424/content/application~1json/examples/webhook_limit_reached-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_subproject-0":{"value":{"errorCode":"failed_to_create_subproject","message":"Failed to create subproject.","resolution":"Please try again."},"key":"failed_to_create_subproject-0","summary":"FailedToCreateSubprojectError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_subproject-0"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_sms_service-1":{"value":{"errorCode":"failed_to_create_sms_service","message":"Failed to create sms service.","resolution":"Please try again."},"key":"failed_to_create_sms_service-1","summary":"FailedToCreateSmsServiceError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_sms_service-1"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_conversation_service-2":{"value":{"errorCode":"failed_to_create_conversation_service","message":"Failed to create conversation service.","resolution":"Please try again."},"key":"failed_to_create_conversation_service-2","summary":"FailedToCreateConversationServiceError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/failed_to_create_conversation_service-2"},"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/internal_error-3":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-3","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1bundles/post/responses/500/content/application~1json/examples/internal_error-3"},"paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example":{"value":{"type":"BUNDLE_DONE","payload":{"id":"62a02dd40000000000000000","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","region":"US","subproject":{"id":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","parentProjectId":"18bbdcc8-117d-42f0-85cc-e30462c49404","status":"READY"},"smsApp":{"id":"54e5eb6cae6242c88c132c8da8bb1072","smsServiceId":"d84b09da00fb4b76ff63f2fcea8d46c7","name":"Sample response","status":"ACTIVE","regions":["US"],"test":false},"convApp":{"id":"31c12b1042d14b37ae96df96bb13575b","name":"Sample response","processingMode":"CONVERSATION","smsChannelStatus":"PENDING"},"webhooks":[{"id":"7c60ce550f1d40198d5ffb113d58591b","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","triggers":["BUNDLE_DONE"]}],"state":"DONE","webhookDeliveryStatuses":[{"webhookId":"7c60ce550f1d40198d5ffb113d58591b","date":"2025-02-14T10:54:15.676Z","httpStatusCode":200}]}},"id":"paths/~1v1~1projects~1{projectId}~1bundles/post/callbacks/BundleDone/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/notReady":{"value":{"id":"62a02dd40000000000000000","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","region":"US","subproject":{"id":"ea026751-3edf-40a9-ad93-1b382bd60a78","name":"Sample response","parentProjectId":"18bbdcc8-117d-42f0-85cc-e30462c49404","status":"PENDING"},"smsApp":{"id":"54e5eb6cae6242c88c132c8da8bb1072","smsServiceId":"d84b09da00fb4b76ff63f2fcea8d46c7","name":"Sample response","status":"PENDING_ADD","regions":["US"],"test":false},"convApp":{"id":"31c12b1042d14b37ae96df96bb13575b","name":"Sample response","processingMode":"CONVERSATION"},"webhooks":[{"id":"7c60ce550f1d40198d5ffb113d58591b","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","target":"https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4","triggers":["BUNDLE_DONE"]}],"state":"IN_PROGRESS"},"key":"notReady","summary":"Pending response","description":"\n    Response if the SMS App is not ready. This is the most likely response.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/notReady"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/ready":{"value":{"id":"55402ee30230777000098701","projectId":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","name":"Bundle name","region":"US","subproject":{"id":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","name":"Subproject name","parentProjectId":"8c9148fa-8f4e-46f6-8229-565ce0f527be","status":"READY"},"smsApp":{"id":"64efff6cae6242c88cfee38da8bb8976","smsServiceId":"566544da00fb4b769008f2fcea9067e3","name":"SMS App name","status":"ACTIVE","regions":["US"],"test":false},"convApp":{"id":"aa252b10e5614b37ff96df96bb560092","name":"Conversation App name","processingMode":"CONVERSATION"},"webhooks":[{"id":"9981ce550f1dfea0005ffb113d581434","projectId":"6b48c78b-b924-433d-9b7d-2bb2a30e7d56","target":"https://webhook.site/de85df25-f474-4997-b50d-264955e3cedb","triggers":["BUNDLE_DONE"]}],"state":"DONE","webhookDeliveryStatuses":[{"webhookId":"9981ce550f1dfea0005ffb113d581434","date":"2026-06-24T11:54:15.123Z","httpStatusCode":200}]},"key":"ready","summary":"Completed response","description":"\n    Response if the SMS App is ready. The data is the same as the callback payload.\n    ","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/200/content/application~1json/examples/ready"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"bundleId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/bundle_not_found-0":{"value":{"errorCode":"bundle_not_found","message":"Bundle not found.","resolution":"Verify that the parameters are correct."},"key":"bundle_not_found-0","summary":"BundleNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/bundle_not_found-0"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/conversation_app_not_found-1":{"value":{"errorCode":"conversation_app_not_found","message":"Conversation App not found.","resolution":"Verify that the appId is correct."},"key":"conversation_app_not_found-1","summary":"ConversationAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/404/content/application~1json/examples/conversation_app_not_found-1"},"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1bundles~1{bundleId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/200/content/application~1json/examples/response":{"value":{"categories":[{"parentCode":"","depth":1,"code":"001","name":"건강","subcategories":[{"parentCode":"001","depth":2,"code":"0001","name":"병원","subcategories":[{"parentCode":"0001","depth":3,"code":"0001","name":"종합병원","subcategories":[]},{"parentCode":"0001","depth":3,"code":"0002","name":"피부과","subcategories":[]},{"parentCode":"0001","depth":3,"code":"0003","name":"성형외과","subcategories":[]}]},{"parentCode":"001","depth":2,"code":"0002","name":"약국","subcategories":[{"parentCode":"0002","depth":3,"code":"0001","name":"약국","subcategories":[]}]},{"parentCode":"001","depth":2,"code":"0003","name":"의료기기/의약품","subcategories":[{"parentCode":"0003","depth":3,"code":"0001","name":"의료기기/의약품","subcategories":[]}]},{"parentCode":"001","depth":2,"code":"0004","name":"건강식품/건강정보","subcategories":[{"parentCode":"0004","depth":3,"code":"0001","name":"건강식품/건강정보","subcategories":[]}]}]},{"parentCode":"","depth":1,"code":"002","name":"교육","subcategories":[{"parentCode":"002","depth":2,"code":"0001","name":"학교","subcategories":[{"parentCode":"0001","depth":3,"code":"0001","name":"유치원","subcategories":[]}]}]}]},"key":"response","summary":"List response.","description":"\n    Response with sender categories.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"categories":[{"name":"회원","nameEnglish":"Membership","subcategories":[{"code":"001001","name":"회원가입","nameEnglish":"Join membership","groupName":"회원","inclusion":"회원가입 완료 내용의 템플릿이 대상입니다. 가입에 따른 축하적립금/쿠폰을 포함합니다.","exclusion":"상품/서비스가입은 구매 > 상품가입 (002002)로 분류합니다."},{"code":"001002","name":"인증/비밀번호/로그인","nameEnglish":"Authentication/Password/Login","groupName":"회원","inclusion":"OTP, 로그인여부, 임시비밀번호, 본인확인 용도의 템플릿이 대상입니다.","exclusion":""},{"code":"001003","name":"회원정보/회원혜택","nameEnglish":"Membership information/Member ship benefits","groupName":"회원","inclusion":"회원등급안내, 혜택안내, 생일/기념일 축하 동의 템플릿이 대상입니다.","exclusion":""}]}]},"key":"response","summary":"List response.","description":"\n    Response with categories.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-2","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1categories~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"senders":[{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"ACTIVE","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","changes":{"status":"REJECTED","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"}]},"key":"response","summary":"List response","description":"\n    Response with senders.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-2":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-2","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/project_not_initialized-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3":{"value":{"errorCode":"invalid_filter_states","message":"Invalid filterStates.","resolution":"Verify that the filterStates used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"ACTIVE, BLOCKED, INACTIVE, SUSPENDED, VERIFYING"}},"key":"invalid_filter_states-3","summary":"InvalidFilterStatesError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-3"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4":{"value":{"errorCode":"invalid_filter_statuses","message":"Invalid filter statuses.","resolution":"Verify that the filterStatuses used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"DRAFT, IN_PROGRESS, REJECTED"}},"key":"invalid_filter_statuses-4","summary":"InvalidFilterStatusesError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/400/content/application~1json/examples/invalid_filter_statuses-4"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full":{"value":{"plusFriendId":"plusFriendId","status":"SUBMIT","saveDraftOnFailure":true,"details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"key":"full","summary":"Full body request","description":"\n      Example of full body to create a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/full"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal":{"value":{"plusFriendId":"plusFriendId","details":{"adminPhoneNo":"+48777777777","name":"Test Name","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"key":"minimal","summary":"Minimal body request","description":"\n      Example of minimal body to create a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/requestBody/content/application~1json/examples/minimal"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/201/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","changes":{"status":"REJECTED","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},"key":"response","summary":"Create response","description":"\n    Response when successfully creating a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-0":{"value":{"errorCode":"file_invalid_mime_type","message":"details.logoImage: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png."},"key":"file_invalid_mime_type-0","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/sender_invalid_category_code-1":{"value":{"errorCode":"sender_invalid_category_code","message":"Invalid sender category code(s).","resolution":"Verify that the sender category code(s) used is supported."},"key":"sender_invalid_category_code-1","summary":"SenderInvalidCategoryCodeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/sender_invalid_category_code-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/invalid_input-2":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["plusFriendId must be longer than or equal to 1 characters"]}},"key":"invalid_input-2","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/400/content/application~1json/examples/invalid_input-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_exists-0":{"value":{"errorCode":"account_exists","message":"Account already exists.","resolution":"There can only be one KakaoTalk account for each project."},"key":"account_exists-0","summary":"AccountExistsError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_exists-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_not_updatable-1":{"value":{"errorCode":"account_not_updatable","message":"Account is not updatable.","resolution":"Please contact support."},"key":"account_not_updatable-1","summary":"AccountNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_not_updatable-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-2":{"value":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"key":"account_data_is_corrupt-2","summary":"AccountDataIsCorruptError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_not_found-3":{"value":{"errorCode":"file_not_found","message":"details.logoImage: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-3","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_not_found-3"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4":{"value":{"errorCode":"file_unexpected_error","message":"details.logoImage: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-4","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-5":{"value":{"errorCode":"file_size_too_large","message":"details.logoImage: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 5MB."},"key":"file_size_too_large-5","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-5"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/plus_friend_id_used-6":{"value":{"errorCode":"plus_friend_id_used","message":"plusFriendId is already used.","resolution":"plusFriendId is already used by another Sender, verify that the parameters are correct."},"key":"plus_friend_id_used-6","summary":"PlusFriendIdUsedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/409/content/application~1json/examples/plus_friend_id_used-6"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/412/content/application~1json/examples/account_is_in_progress-0":{"value":{"errorCode":"account_is_in_progress","message":"Account creation is in progress.","resolution":"Please contact support."},"key":"account_is_in_progress-0","summary":"AccountIsInProgressError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/412/content/application~1json/examples/account_is_in_progress-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_SENDER_ACTIVE","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"ACTIVE","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"}},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Active/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_SENDER_INACTIVE","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"INACTIVE","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"}},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Inactive/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_SENDER_REJECTED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","changes":{"status":"REJECTED","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"}},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_SENDER_COMMENT_ADDED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"INACTIVE","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},"comment":"Example comment"},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"ACTIVE","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},"key":"response","summary":"Get response","description":"\n    Response with a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0":{"value":{"errorCode":"sender_already_deleted","message":"The sender has been deleted within the last 60 days.","resolution":"Wait the required time."},"key":"sender_already_deleted-0","summary":"SenderAlreadyDeletedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/409/content/application~1json/examples/sender_already_deleted-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full":{"value":{"status":"SUBMIT","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"key":"full","summary":"Full body request","description":"\n      Example of full body to update a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/requestBody/content/application~1json/examples/full"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"ACTIVE","changes":{"status":"REJECTED","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}},"details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},"key":"response","summary":"Update response","description":"\n    Response when successfully update a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/responseSenderDraft":{"value":{"plusFriendId":"5WY5zKfY3pB56EmDVUPQ","changes":{"status":"REJECTED","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"}}},"key":"responseSenderDraft","summary":"Update response of a draft","description":"\n    Response when successfully updating a sender draft.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/200/content/application~1json/examples/responseSenderDraft"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-0":{"value":{"errorCode":"file_invalid_mime_type","message":"details.logoImage: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png."},"key":"file_invalid_mime_type-0","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/file_invalid_mime_type-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/invalid_input-1":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["Description of fields failing validation"]}},"key":"invalid_input-1","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/invalid_input-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/project_not_initialized-2":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-2","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/project_not_initialized-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-3":{"value":{"errorCode":"no_fields_to_update","message":"No fields to be updated.","resolution":"Supply at least one field to be updated."},"key":"no_fields_to_update-3","summary":"NoFieldsToUpdateError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-3"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/sender_invalid_category_code-4":{"value":{"errorCode":"sender_invalid_category_code","message":"Invalid sender category code(s).","resolution":"Verify that the sender category code(s) used is supported."},"key":"sender_invalid_category_code-4","summary":"SenderInvalidCategoryCodeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/400/content/application~1json/examples/sender_invalid_category_code-4"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/sender_not_found-1":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-1","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/404/content/application~1json/examples/sender_not_found-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_not_found-0":{"value":{"errorCode":"file_not_found","message":"details.logoImage: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-0","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-1":{"value":{"errorCode":"file_unexpected_error","message":"details.logoImage: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-1","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_unexpected_error-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_size_too_large-2":{"value":{"errorCode":"file_size_too_large","message":"details.logoImage: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 5MB."},"key":"file_size_too_large-2","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/file_size_too_large-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-3":{"value":{"errorCode":"sender_changes_not_updatable","message":"Sender is not updatable.","resolution":"Updates are only supported by sender changes with status: DRAFT"},"key":"sender_changes_not_updatable-3","summary":"SenderChangesNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_changes_not_updatable-3"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-4":{"value":{"errorCode":"sender_not_updatable","message":"Sender is not updatable.","resolution":"Updates are only supported by senders with state: ACTIVE."},"key":"sender_not_updatable-4","summary":"SenderNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/409/content/application~1json/examples/sender_not_updatable-4"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}/patch/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-12-20T15:00:11.310Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-12-20T15:00:10.303Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List sender activities response","description":"Response for all sender activities.","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-1","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-2","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0":{"value":{"errorCode":"sender_changes_not_found","message":"Sender changes not found.","resolution":"Verify that the parameters are correct."},"key":"sender_changes_not_found-0","summary":"SenderChangesNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/404/content/application~1json/examples/sender_changes_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0":{"value":{"errorCode":"sender_changes_not_deletable","message":"Sender changes is not deletable.","resolution":"Only DRAFT, REJECTED senders changes can be marked for deletion."},"key":"sender_changes_not_deletable-0","summary":"SenderChangesNotDeletableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/409/content/application~1json/examples/sender_changes_not_deletable-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n        Example body request to create a comment.\n        ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n        Response when successfully creating a comment.\n        ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["details.buttons.0.name must be a string"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-2","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"VERIFYING","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},"key":"response","summary":"Register response","description":"\n    Response when successfully registering a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/invalid_app_key-1":{"value":{"errorCode":"invalid_app_key","message":"Invalid app key.","resolution":"Please check if the app key is correct"},"key":"invalid_app_key-1","summary":"InvalidAppKeyError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/400/content/application~1json/examples/invalid_app_key-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0":{"value":{"errorCode":"not_allowed_register","message":"Sender not allowed to be registered.","resolution":"Sender in \"ACTIVE\" state can't be registered."},"key":"not_allowed_register-0","summary":"NotAllowedRegisterError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/409/content/application~1json/examples/not_allowed_register-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1register/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input":{"value":{"code":123456},"key":"input","summary":"Body request","description":"\n      Example body request to verify.\n      ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","plusFriendId":"5WY5zKfY3pB56EmDVUPQ","state":"ACTIVE","details":{"adminPhoneNo":"+48777777777","name":"Test Name","logoImage":"https://example-logo-image.com","topLevelCategoryCode":"019","midLevelCategoryCode":"0006","subLevelCategoryCode":"0001"},"created":"2023-02-23T11:28:51.194Z","modified":"2023-02-23T11:28:51.194Z"},"key":"response","summary":"Verify response","description":"\n    Response when successfully verified a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0":{"value":{"errorCode":"not_allowed_verify","message":"Sender not allowed to be verified.","resolution":"Sender has to be in \"VERIFYING\" state to be verified."},"key":"not_allowed_verify-0","summary":"NotAllowedVerifyError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/409/content/application~1json/examples/not_allowed_verify-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1verify/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"templates":[{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","state":"APPROVED","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"},{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","state":"APPROVED","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]},"changes":{"status":"IN_PROGRESS","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]}},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"}]},"key":"response","summary":"List response","description":"\n    Response with templates.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-2","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/400/content/application~1json/examples/invalid_page_token-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/template_not_found-1":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-1","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/404/content/application~1json/examples/template_not_found-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal":{"value":{"details":{"name":"Example name","content":"Example content","language":"EN"}},"key":"minimal","summary":"Minimum example","description":"\n    Minimum body to create a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/minimal"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full":{"value":{"status":"SUBMIT","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]}},"key":"full","summary":"Full example","description":"\n    Full body to create a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/requestBody/content/application~1json/examples/full"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/201/content/application~1json/examples/response":{"value":{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","changes":{"status":"IN_PROGRESS","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]}},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"},"key":"response","summary":"Create response","description":"\n    Response when successfully creating a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/template_invalid_category_code-1":{"value":{"errorCode":"template_invalid_category_code","message":"Invalid template category code.","resolution":"Verify that the template category code used is supported for the provided project."},"key":"template_invalid_category_code-1","summary":"TemplateInvalidCategoryCodeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/template_invalid_category_code-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/invalid_payload-2":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-2","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/400/content/application~1json/examples/invalid_payload-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/409/content/application~1json/examples/template_exists-0":{"value":{"errorCode":"template_exists","message":"Template already exists.","resolution":"Templates must have unique name. Change name and submit again."},"key":"template_exists-0","summary":"TemplateExistsError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/409/content/application~1json/examples/template_exists-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0":{"value":{"errorCode":"template_kakaotalk_validation_error","message":"Template kakaoTalk validation error: Some details from provider","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{}},"key":"template_kakaotalk_validation_error-0","summary":"TemplateKakaotalkValidationErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1":{"value":{"errorCode":"template_kakaotalk_validation_error","message":"Template kakaoTalk validation error: Some details from provider","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{"templateCode":"AX5NnkwWABRXG7LjDBGa"}},"key":"template_kakaotalk_validation_error-1","summary":"TemplateKakaotalkValidationErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{}},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{"templateCode":"templateCode"}},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-2":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-2","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/responses/500/content/application~1json/examples/internal_error-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_TEMPLATE_COMMENT_ADDED","payload":{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","changes":{"status":"DRAFT","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]}},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"},"comment":"new template comment"},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_TEMPLATE_APPROVED","payload":{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","state":"APPROVED","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"}},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Approved/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example":{"value":{"type":"KAKAOTALK_TEMPLATE_REJECTED","payload":{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","state":"REJECTED","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"}},"id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates/post/callbacks/Rejected/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","state":"APPROVED","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"},"key":"response","summary":"Get response","description":"\n    Response when successfully creating a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/template_not_found-1":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-1","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/404/content/application~1json/examples/template_not_found-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/sender_not_found-1":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-1","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/404/content/application~1json/examples/sender_not_found-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal":{"value":{},"key":"minimal","summary":"Minimum example","description":"\n    Minimum body to update a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/minimal"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full":{"value":{"status":"DRAFT","details":{"messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]}},"key":"full","summary":"Full example","description":"\n    Full body to update a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/requestBody/content/application~1json/examples/full"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/200/content/application~1json/examples/response":{"value":{"id":"1a76b24e-bead-4c72-b468-6c3bdfff0ee6","code":"S7yFqaKqJ8tsnBZH2CEd","changes":{"status":"IN_PROGRESS","details":{"language":"EN","messageType":"BASIC","emphasizeType":"EMPHASIZE_TYPE_NONE","categoryCode":"001001","securityFlag":false,"name":"Example name","content":"Example content","extra":"Example extra","ad":"Example ad","title":"Example title","subtitle":"Example subtitle","imageName":"Example image name","imageUrl":"https://example-image-url.com","buttons":[{"ordering":1,"type":"APP_LINK","name":"Example Name","linkMo":"https://example-link-mo.com","linkPc":"https://example-link-pc.com","schemeIos":"https://example-scheme-ios.com","schemeAndroid":"https://example-scheme-android.com"}]}},"created":"2023-02-24T10:19:31.372Z","modified":"2023-02-24T10:19:31.372Z"},"key":"response","summary":"Update response","description":"\n    Response when successfully updating a template.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/template_invalid_category_code-1":{"value":{"errorCode":"template_invalid_category_code","message":"Invalid template category code.","resolution":"Verify that the template category code used is supported for the provided project."},"key":"template_invalid_category_code-1","summary":"TemplateInvalidCategoryCodeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/400/content/application~1json/examples/template_invalid_category_code-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/template_not_found-1":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-1","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/404/content/application~1json/examples/template_not_found-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_exists-0":{"value":{"errorCode":"template_exists","message":"Template already exists.","resolution":"Templates must have unique name. Change name and submit again."},"key":"template_exists-0","summary":"TemplateExistsError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_exists-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1":{"value":{"errorCode":"template_not_updatable","message":"Template is not updatable.","resolution":"Updates are only supported by templates with state: APPROVED, REJECTED."},"key":"template_not_updatable-1","summary":"TemplateNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_not_updatable-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2":{"value":{"errorCode":"template_changes_not_updatable","message":"Template is not updatable.","resolution":"Updates are only supported by template changes with status: DRAFT, REJECTED."},"key":"template_changes_not_updatable-2","summary":"TemplateChangesNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/409/content/application~1json/examples/template_changes_not_updatable-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0":{"value":{"errorCode":"template_kakaotalk_validation_error","message":"Template kakaoTalk validation error: Some details from provider","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{}},"key":"template_kakaotalk_validation_error-0","summary":"TemplateKakaotalkValidationErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1":{"value":{"errorCode":"template_kakaotalk_validation_error","message":"Template kakaoTalk validation error: Some details from provider","resolution":"Please try again later. If template is saved as draft, try to submit the template again. If option \"saveDraftOnFailure\" is specified as \"false\", try the request again.","additionalInformation":{"templateCode":"AX5NnkwWABRXG7LjDBGa"}},"key":"template_kakaotalk_validation_error-1","summary":"TemplateKakaotalkValidationErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/424/content/application~1json/examples/template_kakaotalk_validation_error-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}/patch/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-01-19T13:11:08.204Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-01-19T13:11:08.204Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List template activities response","description":"\n    Response for all template activities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-1","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-2","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-1":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-1","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/404/content/application~1json/examples/template_not_found-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-0","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/400/content/application~1json/examples/project_not_initialized-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/409/content/application~1json/examples/template_not_deletable-0":{"value":{"errorCode":"template_not_deletable","message":"Template is not deletable.","resolution":"Only templates that has not yet been submitted to KakaoTalk is eligible for deletion."},"key":"template_not_deletable-0","summary":"TemplateNotDeletableError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/409/content/application~1json/examples/template_not_deletable-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1changes/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n      Example body request to create a comment.\n      ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n    Response when successfully creating a comment.\n    ","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["details.buttons.0.name must be a string"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1":{"value":{"errorCode":"project_not_initialized","message":"Project not initialized for KakaoTalk.","resolution":"Verify that the project ID is correct and that it has been onboarded for KakaoTalk."},"key":"project_not_initialized-1","summary":"ProjectNotInitializedError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/project_not_initialized-1"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2":{"value":{"errorCode":"template_invalid_language_code","message":"Invalid language code.","resolution":"Verify that the language code used is supported by the Provisioning API and KakaoTalk.","additionalInformation":{"supportedCodes":"AF, AR, AZ, BG, BN, CA, CS, DA, DE, EL, EN, EN_GB, EN_US, ES, ES_AR, ES_ES, ES_MX, ET, FA, FI, FIL, FR, GA, GU, HA, HE, HI, HR, HU, ID, IT, JA, KA, KK, KN, KO, KY_KG, LO, LT, LV, MK, ML, MR, MS, NB, NL, PA, PL, PT_BR, PT_PT, RO, RU, RW_RW, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TR, UK, UR, UZ, VI, ZH_CN, ZH_HK, ZH_TW, ZU"}},"key":"template_invalid_language_code-2","summary":"TemplateInvalidLanguageCodeError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/template_invalid_language_code-2"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-3","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-3"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0":{"value":{"errorCode":"template_not_found","message":"Template not found.","resolution":"Verify that the parameters are correct."},"key":"template_not_found-0","summary":"TemplateNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/404/content/application~1json/examples/template_not_found-0"},"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1kakaotalk~1senders~1{plusFriendId}~1templates~1{templateCode}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/200/content/application~1json/examples/example":{"value":{"id":"1234567890","username":"Sinch","status":"ACTIVE","followersCount":1,"followsCount":3,"mediaCount":0},"key":"example","summary":"Example sender information response","description":"\n    The information for the Instagram page connected to the Conversation API App.\n    ","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/200/content/application~1json/examples/example"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0":{"value":{"errorCode":"conversation_app_id_invalid","message":"Conversation app id not valid.","resolution":"Verify the id is correct."},"key":"conversation_app_id_invalid-0","summary":"ConversationAppIdInvalidError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0":{"value":{"errorCode":"conversation_app_not_found","message":"Conversation app not found.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_not_found-0","summary":"ConversationAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_no_instagram_channel-1":{"value":{"errorCode":"conversation_app_no_instagram_channel","message":"Conversation app has no initialized Instagram channel.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_no_instagram_channel-1","summary":"ConversationAppNoInstagramChannelError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/404/content/application~1json/examples/conversation_app_no_instagram_channel-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/facebook_api_error-0":{"value":{"errorCode":"facebook_api_error","message":"Facebook API returned error.","resolution":"Please try again later."},"key":"facebook_api_error-0","summary":"FacebookApiErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/facebook_api_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1instagram/get/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0":{"value":{"errorCode":"conversation_app_id_invalid","message":"Conversation app id not valid.","resolution":"Verify the id is correct."},"key":"conversation_app_id_invalid-0","summary":"ConversationAppIdInvalidError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_not_found-0":{"value":{"errorCode":"conversation_app_not_found","message":"Conversation app not found.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_not_found-0","summary":"ConversationAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_no_messenger_channel-1":{"value":{"errorCode":"conversation_app_no_messenger_channel","message":"Conversation app has no initialized Messenger channel.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_no_messenger_channel-1","summary":"ConversationAppNoMessengerChannelError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/404/content/application~1json/examples/conversation_app_no_messenger_channel-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/facebook_api_error-0":{"value":{"errorCode":"facebook_api_error","message":"Facebook API returned error.","resolution":"Please try again later."},"key":"facebook_api_error-0","summary":"FacebookApiErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/facebook_api_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1messenger/get/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/200/content/application~1json/examples/example":{"value":{"status":"ACTIVE","name":"Sinch","username":"sinch_bot","canJoinGroups":true,"canReadAllGroupMessages":false,"supportsInlineQueries":false},"key":"example","summary":"Example sender information response","description":"\n    The information for the Telegram sender connected to the Conversation API App.\n    ","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/200/content/application~1json/examples/example"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0":{"value":{"errorCode":"conversation_app_id_invalid","message":"Conversation app id not valid.","resolution":"Verify the id is correct."},"key":"conversation_app_id_invalid-0","summary":"ConversationAppIdInvalidError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/400/content/application~1json/examples/conversation_app_id_invalid-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0":{"value":{"errorCode":"conversation_app_not_found","message":"Conversation app not found.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_not_found-0","summary":"ConversationAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_no_telegram_channel-1":{"value":{"errorCode":"conversation_app_no_telegram_channel","message":"Conversation app has no initialized Telegram channel.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_no_telegram_channel-1","summary":"ConversationAppNoTelegramChannelError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/404/content/application~1json/examples/conversation_app_no_telegram_channel-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/telegram_api_error-0":{"value":{"errorCode":"telegram_api_error","message":"Telegram API returned error: 400, description: Bad Request: PHOTO_CROP_SIZE_SMALL.","resolution":"Please try again later."},"key":"telegram_api_error-0","summary":"TelegramApiErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/telegram_api_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1telegram/get/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_not_found-0":{"value":{"errorCode":"conversation_app_not_found","message":"Conversation app not found.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_not_found-0","summary":"ConversationAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_no_viber_channel-1":{"value":{"errorCode":"conversation_app_no_viber_channel","message":"Conversation app has no initialized Viber channel.","resolution":"Verify that the parameters are correct."},"key":"conversation_app_no_viber_channel-1","summary":"ConversationAppNoViberChannelError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/404/content/application~1json/examples/conversation_app_no_viber_channel-1"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/viber_api_error-0":{"value":{"errorCode":"viber_api_error","message":"Viber API returned error.","resolution":"Please try again later."},"key":"viber_api_error-0","summary":"ViberApiErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/viber_api_error-0"},"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/internal_error-1":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-1","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1conversation~1apps~1{conversationAppId}~1viber/get/responses/500/content/application~1json/examples/internal_error-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-02-10T11:41:14.202Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-02-10T11:41:14.202Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List account activities response","description":"\n    Response for all account activities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/404/content/application~1json/examples/account_not_found-0":{"value":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"key":"account_not_found-0","summary":"AccountNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/404/content/application~1json/examples/account_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n      Example body request to create a comment.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n    Response when successfully creating a comment.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["comment must be longer than or equal to 1 characters"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/404/content/application~1json/examples/account_not_found-0":{"value":{"errorCode":"account_not_found","message":"Account not found.","resolution":"Verify that the parameters are correct."},"key":"account_not_found-0","summary":"AccountNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/404/content/application~1json/examples/account_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"RCS_ACCOUNT_COMMENT_ADDED","comment":"Example comment"},"id":"paths/~1v1~1projects~1{projectId}~1rcs~1comments/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPublicQuestionnaireResponse":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]}}}},"key":"usPublicQuestionnaireResponse","summary":"Get US Public questionnaire response","description":"\n    Response with US Public questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPublicQuestionnaireResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPrivateQuestionnaireResponse":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]}}}},"key":"usPrivateQuestionnaireResponse","summary":"Get US Private questionnaire response","description":"\n    Response with US Private questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usPrivateQuestionnaireResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPublicQuestionnaireResponse":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]}}}},"key":"nonUsPublicQuestionnaireResponse","summary":"Get non-US Public questionnaire response","description":"\n    Response with non-US Public questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPublicQuestionnaireResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPrivateQuestionnaireResponse":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}}}},"key":"nonUsPrivateQuestionnaireResponse","summary":"Get non-US Private questionnaire response","description":"\n    Response with non-US Private questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/nonUsPrivateQuestionnaireResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usQuestionnaire":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}}}},"key":"usQuestionnaire","summary":"Get US questionnaire response","description":"\n    Response with questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/usQuestionnaire"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/deprecatedUsQuestionnaire":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}}}},"key":"deprecatedUsQuestionnaire","summary":"[Deprecated] Get US questionnaire response","description":"\n    Response with deprecated US questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/deprecatedUsQuestionnaire"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/gbFrQuestionnaire":{"value":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}}}},"key":"gbFrQuestionnaire","summary":"Get GB and FR questionnaire response","description":"\n    Response with GB and FR questionnaire questions.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/200/content/application~1json/examples/gbFrQuestionnaire"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_use_case-0":{"value":{"errorCode":"questionnaire_invalid_use_case","message":"Invalid use case value.","resolution":"Verify that the use case value is supported by the Provisioning API.","additionalInformation":{"validUseCases":"MULTIUSE, OTP, PROMOTIONAL, TRANSACTIONAL"}},"key":"questionnaire_invalid_use_case-0","summary":"QuestionnaireInvalidUseCaseError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_use_case-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_country-1":{"value":{"errorCode":"questionnaire_invalid_country","message":"Invalid country.","resolution":"Use the supported values for the countries parameter.","additionalInformation":{"supportedValues":"AT, BE, BR, CA, CZ, DK, FI, FR, DE, GR, HU, IT, LT, MX, NL, NO, PE, PL, PT, SG, SK, ES, SE, US, GB"}},"key":"questionnaire_invalid_country-1","summary":"QuestionnaireInvalidCountryError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/400/content/application~1json/examples/questionnaire_invalid_country-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1questionnaire~1{useCase}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/newResponse":{"value":{"totalSize":2,"pageSize":50,"senders":[{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}}]},"key":"newResponse","summary":"List response","description":"\n    Response with senders.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/newResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"senders":[{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}}]},"key":"response","summary":"[Deprecated] List response","description":"\n    Response with senders.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-2":{"value":{"errorCode":"invalid_filter_states","message":"Invalid filterStates.","resolution":"Verify that the filterStates used are supported by the Provisioning API.","additionalInformation":{"supportedCodes":"DRAFT, IN_PROGRESS, IN_TEST, LAUNCHED, LAUNCHING, PREPARING_LAUNCH, UNLAUNCHED, UNKNOWN"}},"key":"invalid_filter_states-2","summary":"InvalidFilterStatesError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/400/content/application~1json/examples/invalid_filter_states-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0":{"value":{"errorCode":"rbm_has_not_been_used","message":"RBM has not been used.","resolution":"Please wait and try again or reach out to support at si-richmessaging@sinch.com"},"key":"rbm_has_not_been_used-0","summary":"RbmHasNotBeenUsedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP"},"key":"minimal","summary":"Minimal body request for sender","description":"\n      Minimal example that only includes the required fields. Other fields can be\n      provided later via an update to complete the sender before launch.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/minimal"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePublicCorporationUsTaxIdCountry","summary":"US questionnaire: PUBLIC + CORPORATION (US taxIdCountry)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch-compatible payload using only the US questionnaire."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This variant uses ownershipType=PUBLIC, legalForm=CORPORATION, taxIdCountry=US,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includes addressState, and includes stockExchange and stockSymbol because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are required for PUBLIC and required by this example."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationUsTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"LIMITED_LIABILITY_COMPANY","taxIdCountry":"US","taxId":"98-7654321","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePrivateLlcUsTaxIdCountry","summary":"US questionnaire: PRIVATE + LIMITED_LIABILITY_COMPANY (US taxIdCountry)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch-compatible payload using only the US questionnaire."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This variant uses ownershipType=PRIVATE and legalForm=LIMITED_LIABILITY_COMPANY"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with taxIdCountry=US, includes addressState, and omits stockExchange and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stockSymbol because they are not allowed for PRIVATE."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcUsTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"PARTNERSHIP","taxIdCountry":"US","taxId":"23-4567890","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePrivatePartnershipUsTaxIdCountry","summary":"US questionnaire: PRIVATE + PARTNERSHIP (US taxIdCountry)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch-compatible payload using only the US questionnaire."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This variant uses ownershipType=PRIVATE and legalForm=PARTNERSHIP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with taxIdCountry=US, includes addressState, and omits stockExchange and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stockSymbol because they are not allowed for PRIVATE."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipUsTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"S_CORPORATION","taxIdCountry":"US","taxId":"87-6543210","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePrivateSCorporationUsTaxIdCountry","summary":"US questionnaire: PRIVATE + S_CORPORATION (US taxIdCountry)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch-compatible payload using only the US questionnaire."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This variant uses ownershipType=PRIVATE and legalForm=S_CORPORATION"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with taxIdCountry=US, includes addressState, and omits stockExchange and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stockSymbol because they are not allowed for PRIVATE."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateSCorporationUsTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"DE","taxId":"DE-TAX-12345","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"DE","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePublicCorporationGermanyTaxIdCountry","summary":"US questionnaire: PUBLIC + CORPORATION (DE taxIdCountry)","description":"\n      Launch-compatible payload using only the US questionnaire.\n      This variant demonstrates a non-US taxIdCountry (DE) where taxId is treated\n      as a generic string, addressState is omitted, and includes stockExchange and stockSymbol because\n      they are required for PUBLIC and required by this example.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePublicCorporationGermanyTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"LIMITED_LIABILITY_COMPANY","taxIdCountry":"SE","taxId":"SE-TAX-54321","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"DE","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePrivateLlcSwedenTaxIdCountry","summary":"US questionnaire: PRIVATE + LIMITED_LIABILITY_COMPANY (SE taxIdCountry)","description":"\n      Launch-compatible payload using only the US questionnaire.\n      This variant demonstrates another non-US taxIdCountry (SE), keeping the\n      same US questionnaire shape while passing validation. addressState is\n      omitted, and omits stockExchange and stockSymbol because they are not allowed for PRIVATE.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivateLlcSwedenTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["US"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"us":{"answers":{"ownershipType":"PRIVATE","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"PARTNERSHIP","taxIdCountry":"GB","taxId":"GB-TAX-778899","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"DE","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry","summary":"US questionnaire: PRIVATE + PARTNERSHIP (GB taxIdCountry)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch-compatible payload using only the US questionnaire."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This variant demonstrates taxIdCountry=GB together with PRIVATE ownership"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and PARTNERSHIP legal form. addressState is omitted, and omits stockExchange and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stockSymbol because they are not allowed for PRIVATE."},"children":[]}]}]}],"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input":{"value":{"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["GB","FR"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}}},"key":"input","summary":"[Deprecated] Body request for sender","description":"\n      Example body request to create a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/newResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newResponse","summary":"Create response","description":"\n    Response when successfully creating a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/newResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"response","summary":"[Deprecated] Create response","description":"\n    Response when successfully creating a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/201/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["details.brand.email.address must be an email"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-1":{"value":{"errorCode":"file_invalid_mime_type","message":"details.brand.bannerUrl: invalid file mime type.","resolution":"Try again with supported mime types: image/jpeg, image/png."},"key":"file_invalid_mime_type-1","summary":"FileInvalidMimeTypeError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/file_invalid_mime_type-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_payload-2":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-2","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_payload-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_google_agent-3":{"value":{"errorCode":"invalid_google_agent","message":"message","resolution":"Verify the sender's fields."},"key":"invalid_google_agent-3","summary":"InvalidGoogleAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/invalid_google_agent-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/add_test_number_invalid-4":{"value":{"errorCode":"add_test_number_invalid","message":"Invalid phone number.","resolution":"Please verify that phone number is correct."},"key":"add_test_number_invalid-4","summary":"AddTestNumberInvalidError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/400/content/application~1json/examples/add_test_number_invalid-4"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0":{"value":{"errorCode":"rbm_has_not_been_used","message":"RBM has not been used.","resolution":"Please wait and try again or reach out to support at si-richmessaging@sinch.com"},"key":"rbm_has_not_been_used-0","summary":"RbmHasNotBeenUsedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_webhook_incorrect_secret-1":{"value":{"errorCode":"rbm_webhook_incorrect_secret","message":"RBM webhook has incorrect secret","resolution":"Please wait and try again or reach out to support at si-richmessaging@sinch.com"},"key":"rbm_webhook_incorrect_secret-1","summary":"RbmWebhookIncorrectSecretError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/403/content/application~1json/examples/rbm_webhook_incorrect_secret-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1":{"value":{"errorCode":"rbm_resources_not_found","message":"RBM resources not found.","resolution":"Verify that the parameters are correct, and contact support if error persists."},"key":"rbm_resources_not_found-1","summary":"RbmResourcesNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0":{"value":{"errorCode":"account_data_is_corrupt","message":"Account data is corrupt.","resolution":"Please contact support."},"key":"account_data_is_corrupt-0","summary":"AccountDataIsCorruptError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/account_data_is_corrupt-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_not_found-1":{"value":{"errorCode":"file_not_found","message":"details.brand.logoUrl: file not found.","resolution":"Verify that the url is correct."},"key":"file_not_found-1","summary":"FileNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_not_found-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-2":{"value":{"errorCode":"file_size_too_large","message":"details.brand.bannerUrl: file size is too large.","resolution":"Try again with a smaller file. Max size for `image/jpeg` is 200KB."},"key":"file_size_too_large-2","summary":"FileSizeTooLargeError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_size_too_large-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-3":{"value":{"errorCode":"file_has_wrong_dimensions","message":"details.brand.logoUrl: image has wrong dimensions.","resolution":"Try again with image dimensions: exact 224 x 224 px."},"key":"file_has_wrong_dimensions-3","summary":"FileHasWrongDimensionsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_has_wrong_dimensions-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4":{"value":{"errorCode":"file_unexpected_error","message":"details.brand.logoUrl: file unexpected error.","resolution":"The file cannot be handled properly. Please try with another one."},"key":"file_unexpected_error-4","summary":"FileUnexpectedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/409/content/application~1json/examples/file_unexpected_error-4"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody/content/application~1json/example":{"value":{"type":"RCS_SENDER_STATUS_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"previousState":"IN_PROGRESS","currentState":"IN_TEST"},"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/StatusUpdate/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody/content/application~1json/example":{"value":{"type":"RCS_SENDER_OPERATOR_STATUS_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"LAUNCHED","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"SE","status":"LAUNCHED","operators":[{"name":"Tele2","status":"LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"REJECTED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"operator":"Free","operatorCountry":"FR","operatorPreviousStatus":"PENDING","operatorCurrentStatus":"LAUNCHED"},"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/OperatorStatusUpdate/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example":{"value":{"type":"RCS_SENDER_COMMENT_ADDED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_PROGRESS","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"comment":"Example comment"},"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/Comment/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody/content/application~1json/example":{"value":{"type":"RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED","payload":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"status":"COMPLETED","comment":"Brand registration approved"},"id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders/post/callbacks/BrandOrderStatusUpdate/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newInTest":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newInTest","summary":"Get response inTest","description":"\n    Response with a sender inTest.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newInTest"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunch":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newPreparingLaunch","summary":"Get response preparingLaunch","description":"\n    Response with a sender preparingLaunch.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunch"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newLaunching":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"LAUNCHING","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newLaunching","summary":"Get response launching","description":"\n    Response with a sender launching.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newLaunching"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunchBrand":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}},"brandDetails":{"id":"eceed77f-22f6-42bc-b2ce-3fe65916028e","status":"DRAFT","registration":{"id":"2ea4f0aa-f85d-4785-9ad9-0b08bbc148c2","status":"NEW"}}},"key":"newPreparingLaunchBrand","summary":"Get response preparingLaunchBrand","description":"\n    Response with a sender preparingLaunchBrand.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/newPreparingLaunchBrand"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/inTest":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"inTest","summary":"[Deprecated] Get response inTest","description":"\n    Response with a sender inTest.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/inTest"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/preparingLaunch":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"preparingLaunch","summary":"[Deprecated] Get response preparingLaunch","description":"\n    Response with a sender preparingLaunch.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/preparingLaunch"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/launching":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"LAUNCHING","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"launching","summary":"[Deprecated] Get response launching","description":"\n    Response with a sender launching.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/200/content/application~1json/examples/launching"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0":{"value":{"errorCode":"rbm_has_not_been_used","message":"RBM has not been used.","resolution":"Please wait and try again or reach out to support at si-richmessaging@sinch.com"},"key":"rbm_has_not_been_used-0","summary":"RbmHasNotBeenUsedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput":{"value":{"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["GB","FR"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}}},"key":"newInput","summary":"Body request for sender","description":"\n      Example body request to update a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/newInput"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input":{"value":{"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["GB","FR"],"questionnaire":{"general":{"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}}},"key":"input","summary":"[Deprecated] Body request for sender","description":"\n      Example body request to update a sender.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/newResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newResponse","summary":"Update response","description":"\n    Response when successfully updated a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/newResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"IN_TEST","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"NOT_LAUNCHED","operators":[{"name":"Coriolis Telecom","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"NOT_LAUNCHED","operators":[{"name":"EE","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"NOT_LAUNCHED","operators":[{"name":"Tele2","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"NOT_LAUNCHED","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"response","summary":"[Deprecated] Update response","description":"\n    Response when successfully updated a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["details.brand.email.address must be an email"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_id_format-1":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-1","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_id_format-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-2":{"value":{"errorCode":"no_fields_to_update","message":"No fields to be updated.","resolution":"Supply at least one field to be updated."},"key":"no_fields_to_update-2","summary":"NoFieldsToUpdateError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/fields_not_updatable-3":{"value":{"errorCode":"fields_not_updatable","message":"Fields not updatable.","resolution":"Only `details.countries` and `details.launch` can be updated when in state:  LAUNCHING, LAUNCHED."},"key":"fields_not_updatable-3","summary":"FieldsNotUpdatableError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/fields_not_updatable-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-4":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-4","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_payload-4"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_google_agent-5":{"value":{"errorCode":"invalid_google_agent","message":"message","resolution":"Verify the sender's fields."},"key":"invalid_google_agent-5","summary":"InvalidGoogleAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_google_agent-5"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/add_test_number_invalid-6":{"value":{"errorCode":"add_test_number_invalid","message":"Invalid phone number.","resolution":"Please verify that phone number is correct."},"key":"add_test_number_invalid-6","summary":"AddTestNumberInvalidError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/add_test_number_invalid-6"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-7":{"value":{"errorCode":"invalid_region_for_att_supplier","message":"Invalid region for ATT supplier.","resolution":"ATT supplier is only allowed in the US region."},"key":"invalid_region_for_att_supplier-7","summary":"InvalidRegionForAttSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-7"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/403/content/application~1json/examples/rbm_has_not_been_used-0":{"value":{"errorCode":"rbm_has_not_been_used","message":"RBM has not been used.","resolution":"Please wait and try again or reach out to support at si-richmessaging@sinch.com"},"key":"rbm_has_not_been_used-0","summary":"RbmHasNotBeenUsedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-1":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-1","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/sender_not_found-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/rbm_resources_not_found-2":{"value":{"errorCode":"rbm_resources_not_found","message":"RBM resources not found.","resolution":"Verify that the parameters are correct, and contact support if error persists."},"key":"rbm_resources_not_found-2","summary":"RbmResourcesNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/rbm_resources_not_found-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3":{"value":{"errorCode":"blocked_because_the_recipient_declined","message":"Blocked because the recipient declined.","resolution":"This operation is blocked because the recipient declined the invitation to become a tester."},"key":"blocked_because_the_recipient_declined-3","summary":"BlockedBecauseTheRecipientDeclinedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}/patch/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":2,"pageSize":50,"notifications":[{"type":"CREATED","created":"2023-02-10T11:41:14.202Z","author":"Provisioning API user"},{"type":"COMMENT_ADDED","created":"2023-02-10T11:41:14.202Z","comment":"Example comment","author":"Provisioning API user"}]},"key":"response","summary":"List sender activities response","description":"\n    Response for all sender activities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_id_format-2":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-2","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/400/content/application~1json/examples/invalid_id_format-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1activities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input":{"value":{"comment":"Example comment."},"key":"input","summary":"Body request","description":"\n      Example body request to create a comment.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created":{"value":{"type":"CREATED","comment":"Example comment","created":"2023-01-19T13:11:08.204Z"},"key":"created","summary":"Create response","description":"\n    Response when successfully creating a comment.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["comment must be longer than or equal to 1 characters"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_id_format-2":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-2","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/400/content/application~1json/examples/invalid_id_format-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1comments/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newLaunchingResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"LAUNCHING","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newLaunchingResponse","summary":"Launching response","description":"\n    Response when successfully launching a sender with all required attributes.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newLaunchingResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"newPreparingLaunchResponse","summary":"Preparing launch response","description":"\n    Response when successfully launching a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchBrandResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"ownershipType":{"question":"What is the ownership type of your company?","suggestedAnswers":["PRIVATE","PUBLIC"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyPhoneNumber":{"question":"What is the primary phone number of your company?","suggestedAnswers":[]},"companyEmailAddress":{"question":"What is the primary email address of your company?","suggestedAnswers":[]},"brandName":{"question":"What is your brand name or Doing Business As (DBA)?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NON_GOVERNMENTAL_ORGANIZATION","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"legalForm":{"question":"What is the legal form of your company?","suggestedAnswers":["CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","S_CORPORATION"]},"taxIdCountry":{"question":"In which country is your company's tax ID registered?","suggestedAnswers":[]},"taxId":{"question":"For non-US companies: what is the tax ID of your company?","suggestedAnswers":[]},"addressLine":{"question":"What is the primary street address of your company?","suggestedAnswers":[]},"addressCity":{"question":"In which city is your company located?","suggestedAnswers":[]},"addressCountry":{"question":"In which country is your company located?","suggestedAnswers":[]},"addressState":{"question":"In which state is your company located?","suggestedAnswers":[]},"addressPostalCode":{"question":"What is the postal code for your company address?","suggestedAnswers":[]},"websiteUrl":{"question":"What is the primary website URL for your company?","suggestedAnswers":[]},"contactFirstName":{"question":"What is the first name of the responsible contact person for your company?","suggestedAnswers":[]},"contactSurname":{"question":"What is the surname of the responsible contact person for your company?","suggestedAnswers":[]},"stockExchange":{"question":"What is the primary home country stock exchange abbreviation?","suggestedAnswers":[]},"stockSymbol":{"question":"What is the primary home country stock symbol associated with the stock exchange?","suggestedAnswers":[]},"sampleMessages":{"question":"Please provide sample messages for each use case or message type sent by your brand.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the expected message volume?","suggestedAnswers":[]},"embeddedLink":{"question":"Does your brand send messages that contain embedded links to external websites?","suggestedAnswers":[]},"embeddedPhone":{"question":"Does your brand send messages that contain embedded phone numbers for direct calling?","suggestedAnswers":[]},"ageGatedContent":{"question":"Does your brand send messages that contain age-gated content or require age verification?","suggestedAnswers":[]},"directLending":{"question":"Does your brand send messages that involve direct lending or financial services?","suggestedAnswers":[]},"optInConfirmationMessage":{"question":"Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?","suggestedAnswers":[]},"helpMessage":{"question":"Does your brand send help messages that provide assistance or support information to users?","suggestedAnswers":[]},"callToActionMessage":{"question":"Does your brand send call-to-action messages that encourage users to take specific actions?","suggestedAnswers":[]}},"answers":{"ownershipType":"PUBLIC","companyLegalName":"Example company legal name","companyPhoneNumber":"+48777777777","companyEmailAddress":"email@example.com","brandName":"Example brand name","brandIndustry":"AGRICULTURE","legalForm":"CORPORATION","taxIdCountry":"US","taxId":"12-3456789","addressLine":"123 Main St","addressCity":"Anytown","addressCountry":"US","addressState":"CA","addressPostalCode":"12345","websiteUrl":"https://example.com","contactFirstName":"John","contactSurname":"Doe","stockExchange":"NASDAQ","stockSymbol":"EXMPL","sampleMessages":["Sample message 1 for the US questionnaire.","Sample message 2 for the US questionnaire."],"messagesVolume":10000,"embeddedLink":true,"embeddedPhone":true,"ageGatedContent":false,"directLending":false,"optInConfirmationMessage":"Thank you for opting in!","helpMessage":"For help, contact support.","callToActionMessage":"Click here to claim your special offer and explore our latest updates now."}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}},"brandDetails":{"id":"eceed77f-22f6-42bc-b2ce-3fe65916028e","status":"DRAFT","registration":{"id":"2ea4f0aa-f85d-4785-9ad9-0b08bbc148c2","status":"NEW"}}},"key":"newPreparingLaunchBrandResponse","summary":"Preparing launch response with brand approval","description":"\n    Response when successfully launching a sender that is waiting on brand approval.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/newPreparingLaunchBrandResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/launchingResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"LAUNCHING","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"launchingResponse","summary":"[Deprecated] Launching response","description":"\n    Response when successfully launching a sender with all required attributes.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/launchingResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/preparingLaunchResponse":{"value":{"id":"cf11794a-6a5e-4a12-b103-da79bd378bf1","state":"PREPARING_LAUNCH","testNumberStates":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}],"countryStatus":[{"country":"FR","status":"PENDING","operators":[{"name":"Coriolis Telecom","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Lycamobile","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Bouygues","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Free","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"NRJ Mobile","status":"REJECTED","remark":"Sender was rejected due to operator policy.","modified":"2023-01-19t13:11:08.204Z"},{"name":"SFR","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"},{"name":"Orange","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"GB","status":"PENDING","operators":[{"name":"EE","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Sky","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"O2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Vodafone","status":"SUSPENDED","modified":"2023-01-19t13:11:08.204Z"}]},{"country":"SE","status":"PENDING","operators":[{"name":"Tele2","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telenor","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Telia","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"},{"name":"Three","status":"PENDING","modified":"2023-01-19t13:11:08.204Z"}]}],"details":{"brand":{"emails":[{"label":"label","address":"test@test.com"},{"label":"label-1","address":"test-1@test.com"},{"label":"label-2","address":"test-2@test.com"}],"phones":[{"label":"label","number":"+48777777777"},{"label":"label-1","number":"48888888888"},{"label":"label-2","number":"+48999999999"}],"websites":[{"label":"label","url":"https://example.com"},{"label":"label-1","url":"https://example-1.com"},{"label":"label-2","url":"https://example-2.com"}],"color":"#000000","description":"Test description","bannerUrl":"https://example-banner-url.com","logoUrl":"https://example-logo-url.com","privacyPolicyUrl":"https://example-private-policy-url.com","termsOfServiceUrl":"https://example-terms-of-service-url.com","name":"Test name"},"testNumbers":["+48777777777"],"countries":["FR","GB","SE"],"questionnaire":{"general":{"questions":{"optInDescription":{"question":"How do users agree to receive messages from your business through the agent?","suggestedAnswers":["By subscribing to our loyalty program","By making a purchase in-store or online","By subscribing to a newsletter","By creating an account on our website or app"]},"triggerDescription":{"question":"When does your business send messages to users through the agent?","suggestedAnswers":["User actions (e.g. after making a purchase)"]},"interactionsDescription":{"question":"How will users interact with your business through the agent?","suggestedAnswers":["Online Payment","Password reset","OTP/2FA for account login"]},"optOutDescription":{"question":"What message does your business send when a user opts out?","suggestedAnswers":["Thank you for opting out","Thank you for unsubscribing","We have registered your opt out request"]},"videoUris":{"question":"","suggestedAnswers":[]},"screenshotUris":{"question":"","suggestedAnswers":[]}},"answers":{"optInDescription":"By subscribing to a newsletter","triggerDescription":"User actions (e.g. after making a purchase)","interactionsDescription":"Billing or payment reminders,aef Order updates,aef Upon package delivery","interactionsDescriptionMetadata":{"ignore":",aef"},"optOutDescription":"We have registered your opt out request","videoUris":["https://example-video-url.com"],"screenshotUris":["https://example-screenshot-url.com"]}},"verification":{"questions":{"name":{"question":"What is the name of your verification contact?","suggestedAnswers":[]},"email":{"question":"What is the email of your verification contact?","suggestedAnswers":[]},"title":{"question":"What is the title of your verification contact?","suggestedAnswers":[]},"website":{"question":"What is the website of your verification contact?","suggestedAnswers":[]},"phone":{"question":"What is the phone number of your verification contact?","suggestedAnswers":[]},"partner":{"companyName":{"question":"For ASP resellers: what is the name of the brand partner company?","suggestedAnswers":[]},"contactName":{"question":"For ASP resellers: what is the name of the brand partner contact person?","suggestedAnswers":[]},"contactEmailAddress":{"question":"For ASP resellers: what is the email of the brand partner contact person?","suggestedAnswers":[]}}},"answers":{"name":"Exam Ple","email":"email@example.com","title":"Head Example","website":"https://example.com","phone":"+48777777777","partner":{"companyName":"Partner company","contactName":"Partner contact name","contactEmailAddress":"partner.contact@partner-company.com"}}},"gb":{"questions":{"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"companyRegistrationNumber":{"question":"What is the registration number of your company?","suggestedAnswers":[]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]},"messagesFrequency":{"question":"How often do you expect to send messages?","suggestedAnswers":["Once per day","Once per week","Once per month","Once per 3 months","Once per 6 months"]},"campaignLength":{"question":"What will be the length of the RCS campaign?","suggestedAnswers":["1 day or less","2 to 7 days","8 to 21 days","1 month","3 months","6 months","Continuous / ongoing"]}},"answers":{"brandIndustry":"Automotive","companyLegalName":"Example company legal name","companyRegistrationNumber":"123-123456789","fullCompanyAddress":"Skeppsbron 1 Malmö, 123 12, Sweden","messagesVolume":"10K - 100K messages","messagesFrequency":"Once per month"}},"fr":{"questions":{"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"siren":{"question":"What is your Company directory identification system number (SIREN)?","suggestedAnswers":[]}},"answers":{"fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"siren":"123456789"}},"us":{"questions":{"companyLegalName":{"question":"What is the registered legal name of your company?","suggestedAnswers":[]},"ein":{"question":"What is the Employer Identification Number (EIN) of your company?","suggestedAnswers":[]},"brandIndustry":{"question":"What sector or industry does your business operate in?","suggestedAnswers":["Automotive","Beauty, spa and salon","Clothing","Education","Entertainment","Event planning and service","Finance and banking","Food and groceries","Public service","Hotel and lodging","Medical and health","Charity","Professional services","Shopping and retail","Travel and transportation","Restaurant"]},"fullCompanyAddress":{"question":"Full Company Address","suggestedAnswers":[]},"smsCampaign":{"question":"US SMS campaign used as fallback.","suggestedAnswers":[]},"messagesVolume":{"question":"What is the total volume of messages expected to be sent by your agent?","suggestedAnswers":["0 - 10K messages","10K - 100K messages","100K - 1M messages","1M+ messages"]}},"answers":{"companyLegalName":"Example company legal name","ein":"12-3456789","brandIndustry":"Automotive","fullCompanyAddress":"Skeppsbron 1-split-211 20-split-Malmö","fullCompanyAddressMetadata":{"ignore":"-split-"},"smsCampaign":"We have registered your opt out request","messagesVolume":"10K - 100K messages"}}}},"region":"EU","billingCategory":"CONVERSATIONAL","useCase":"OTP","hostingRegion":"EUROPE","authName":"yurwN6123asd","authToken":"ejiiqJtDyurwN6jLze8v","conversationApiApp":"4CF9CE97504C4A468F4610919D17ECC1","conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"created":"2023-01-19t13:11:08.204Z","modified":"2023-01-19t13:11:08.204Z","launched":"2023-01-19t13:11:08.204Z","supplierDetails":{"google":{"agentId":"agentId","brandId":"brandId"}}},"key":"preparingLaunchResponse","summary":"[Deprecated] Preparing launch response","description":"\n    Response when successfully launching a sender.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/200/content/application~1json/examples/preparingLaunchResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/verification_suspended_in_gmb-0":{"value":{"errorCode":"verification_suspended_in_gmb","message":"Associated Google My Business is suspended","resolution":"Reverify Google My Business."},"key":"verification_suspended_in_gmb-0","summary":"VerificationSuspendedInGmbError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/verification_suspended_in_gmb-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_id_format-1":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-1","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_id_format-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2":{"value":{"errorCode":"invalid_region_for_att_supplier","message":"Invalid region for ATT supplier.","resolution":"ATT supplier is only allowed in the US region."},"key":"invalid_region_for_att_supplier-2","summary":"InvalidRegionForAttSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0":{"value":{"errorCode":"rbm_has_not_been_used","message":"RBM has not been used.","resolution":"Please wait and try again or reach out to support at si-richmessaging@sinch.com"},"key":"rbm_has_not_been_used-0","summary":"RbmHasNotBeenUsedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/403/content/application~1json/examples/rbm_has_not_been_used-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1":{"value":{"errorCode":"rbm_resources_not_found","message":"RBM resources not found.","resolution":"Verify that the parameters are correct, and contact support if error persists."},"key":"rbm_resources_not_found-1","summary":"RbmResourcesNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/404/content/application~1json/examples/rbm_resources_not_found-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_agent_state-0":{"value":{"errorCode":"launch_invalid_agent_state","message":"Sender can't be launched.","resolution":"Launch are only supported by senders with state: IN_TEST, LAUNCHING, LAUNCHED, UNLAUNCHED."},"key":"launch_invalid_agent_state-0","summary":"LaunchInvalidAgentStateError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_agent_state-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_verification_state-1":{"value":{"errorCode":"launch_invalid_verification_state","message":"Sender verification can't be updated.","resolution":"Sender verification update are only supported by verifications with state: VERIFICATION_STATE_PENDING."},"key":"launch_invalid_verification_state-1","summary":"LaunchInvalidVerificationStateError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/409/content/application~1json/examples/launch_invalid_verification_state-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/412/content/application~1json/examples/launch_precondition_failed-0":{"value":{"errorCode":"launch_precondition_failed","message":"Launch precondition failed.","resolution":"Correct the precondition errors and launch again.","additionalInformation":{"validationErrors":["validation.error"]}},"key":"launch_precondition_failed-0","summary":"LaunchPreconditionFailedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/412/content/application~1json/examples/launch_precondition_failed-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1launch/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput":{"value":{"testNumbers":["+48777777777"]},"key":"newInput","summary":"Body request for add test numbers","description":"\n      Example body request to add test numbers.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/newInput"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input":{"value":{"testNumbers":["+48777777777"]},"key":"input","summary":"[Deprecated] Body request for add test numbers","description":"\n      Example body request to add test numbers.\n      ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/requestBody/content/application~1json/examples/input"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/200/content/application~1json/examples/response":{"value":{"testNumbers":[{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},{"number":"+46123123333","state":"DECLINED","submitted":"2023-01-19t13:11:08.204Z"}]},"key":"response","summary":"Test number states","description":"\n    Test number states.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_input-1":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["each value in testNumbers must be a string"]}},"key":"invalid_input-1","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_input-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/no_google_supplier-2":{"value":{"errorCode":"no_google_supplier","message":"No google supplier in sender.","resolution":"Verify that the sender has google supplier."},"key":"no_google_supplier-2","summary":"NoGoogleSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/no_google_supplier-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/add_test_number_invalid-3":{"value":{"errorCode":"add_test_number_invalid","message":"Invalid phone number.","resolution":"Please verify that phone number is correct."},"key":"add_test_number_invalid-3","summary":"AddTestNumberInvalidError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/add_test_number_invalid-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-4":{"value":{"errorCode":"invalid_region_for_att_supplier","message":"Invalid region for ATT supplier.","resolution":"ATT supplier is only allowed in the US region."},"key":"invalid_region_for_att_supplier-4","summary":"InvalidRegionForAttSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-4"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/sender_not_found-1":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-1","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/sender_not_found-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2":{"value":{"errorCode":"add_test_number_not_allowed_before_launch","message":"Adding test number not allowed before launch.","resolution":"Carrier does not allow test number to be created prior to sender launch."},"key":"add_test_number_not_allowed_before_launch-2","summary":"AddTestNumberNotAllowedBeforeLaunchError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3":{"value":{"errorCode":"blocked_because_the_recipient_declined","message":"Blocked because the recipient declined.","resolution":"This operation is blocked because the recipient declined the invitation to become a tester."},"key":"blocked_because_the_recipient_declined-3","summary":"BlockedBecauseTheRecipientDeclinedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/user_cannot_be_reached-4":{"value":{"errorCode":"user_cannot_be_reached","message":"message","resolution":"Verify that the user has RCS feature available."},"key":"user_cannot_be_reached-4","summary":"UserCannotBeReachedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/404/content/application~1json/examples/user_cannot_be_reached-4"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/newResponse":{"value":{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},"key":"newResponse","summary":"Test number state","description":"\n    Test number state.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/newResponse"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/response":{"value":{"number":"+46123123222","state":"VERIFIED","submitted":"2023-01-19t13:11:08.204Z"},"key":"response","summary":"[Deprecated] Test number state","description":"\n    Test number state.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/400/content/application~1json/examples/no_google_supplier-0":{"value":{"errorCode":"no_google_supplier","message":"No google supplier in sender.","resolution":"Verify that the sender has google supplier."},"key":"no_google_supplier-0","summary":"NoGoogleSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/400/content/application~1json/examples/no_google_supplier-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/project_not_found-0":{"value":{"errorCode":"project_not_found","message":"Project not found.","resolution":"Verify that the projectId is correct."},"key":"project_not_found-0","summary":"ProjectNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/project_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/sender_not_found-1":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-1","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/sender_not_found-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-2":{"value":{"errorCode":"user_is_not_tester_for_agent","message":"Test number not found.","resolution":"Add test number to agent."},"key":"user_is_not_tester_for_agent-2","summary":"UserIsNotTesterForAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/no_google_supplier-1":{"value":{"errorCode":"no_google_supplier","message":"No google supplier in sender.","resolution":"Verify that the sender has google supplier."},"key":"no_google_supplier-1","summary":"NoGoogleSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/no_google_supplier-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2":{"value":{"errorCode":"invalid_region_for_att_supplier","message":"Invalid region for ATT supplier.","resolution":"ATT supplier is only allowed in the US region."},"key":"invalid_region_for_att_supplier-2","summary":"InvalidRegionForAttSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1":{"value":{"errorCode":"user_is_not_tester_for_agent","message":"Test number not found.","resolution":"Add test number to agent."},"key":"user_is_not_tester_for_agent-1","summary":"UserIsNotTesterForAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/200/content/application~1json/examples/response":{"value":{"features":["REVOCATION","ACTION_DIAL"]},"key":"response","summary":"Get response","description":"\n    Response with test number capabilities.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/no_google_supplier-1":{"value":{"errorCode":"no_google_supplier","message":"No google supplier in sender.","resolution":"Verify that the sender has google supplier."},"key":"no_google_supplier-1","summary":"NoGoogleSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/400/content/application~1json/examples/no_google_supplier-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/403/content/application~1json/examples/wrong_supplier_configuration-0":{"value":{"errorCode":"wrong_supplier_configuration","message":"Wrong supplier configuration is used, configuration needs to be setup via SI team","resolution":"Please reach out to support at si-richmessaging@sinch.com"},"key":"wrong_supplier_configuration-0","summary":"WrongSupplierConfigurationError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/403/content/application~1json/examples/wrong_supplier_configuration-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1":{"value":{"errorCode":"user_is_not_tester_for_agent","message":"Test number not found.","resolution":"Add test number to agent."},"key":"user_is_not_tester_for_agent-1","summary":"UserIsNotTesterForAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/looking_up_the_rbm_agent-2":{"value":{"errorCode":"looking_up_the_rbm_agent","message":"Looking up the RBM agent.","resolution":"There was an error looking up the RBM agent."},"key":"looking_up_the_rbm_agent-2","summary":"LookingUpTheRbmAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/looking_up_the_rbm_agent-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3":{"value":{"errorCode":"blocked_because_the_recipient_declined","message":"Blocked because the recipient declined.","resolution":"This operation is blocked because the recipient declined the invitation to become a tester."},"key":"blocked_because_the_recipient_declined-3","summary":"BlockedBecauseTheRecipientDeclinedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_has_not_accepted_invite-4":{"value":{"errorCode":"user_has_not_accepted_invite","message":"User has not accepted invite to become tester for agent.","resolution":"Please wait and try again later."},"key":"user_has_not_accepted_invite-4","summary":"UserHasNotAcceptedInviteError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_has_not_accepted_invite-4"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_cannot_be_reached-5":{"value":{"errorCode":"user_cannot_be_reached","message":"message","resolution":"Verify that the user has RCS feature available."},"key":"user_cannot_be_reached-5","summary":"UserCannotBeReachedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/404/content/application~1json/examples/user_cannot_be_reached-5"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1capabilities/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/200/content/application~1json/examples/response":{"value":{"number":"+46123123111","state":"UNVERIFIED","submitted":"2023-01-19t13:11:08.204Z"},"key":"response","summary":"Get response","description":"\n    Response with test number state.\n\n    Please note that if you send an invite to verified number, state will be changed to unverified.\n    ","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"senderId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/no_google_supplier-1":{"value":{"errorCode":"no_google_supplier","message":"No google supplier in sender.","resolution":"Verify that the sender has google supplier."},"key":"no_google_supplier-1","summary":"NoGoogleSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/no_google_supplier-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/add_test_number_invalid-2":{"value":{"errorCode":"add_test_number_invalid","message":"Invalid phone number.","resolution":"Please verify that phone number is correct."},"key":"add_test_number_invalid-2","summary":"AddTestNumberInvalidError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/add_test_number_invalid-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-3":{"value":{"errorCode":"invalid_region_for_att_supplier","message":"Invalid region for ATT supplier.","resolution":"ATT supplier is only allowed in the US region."},"key":"invalid_region_for_att_supplier-3","summary":"InvalidRegionForAttSupplierError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/400/content/application~1json/examples/invalid_region_for_att_supplier-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/sender_not_found-0":{"value":{"errorCode":"sender_not_found","message":"Sender not found.","resolution":"Verify that the parameters are correct."},"key":"sender_not_found-0","summary":"SenderNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/sender_not_found-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1":{"value":{"errorCode":"user_is_not_tester_for_agent","message":"Test number not found.","resolution":"Add test number to agent."},"key":"user_is_not_tester_for_agent-1","summary":"UserIsNotTesterForAgentError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/user_is_not_tester_for_agent-1"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2":{"value":{"errorCode":"add_test_number_not_allowed_before_launch","message":"Adding test number not allowed before launch.","resolution":"Carrier does not allow test number to be created prior to sender launch."},"key":"add_test_number_not_allowed_before_launch-2","summary":"AddTestNumberNotAllowedBeforeLaunchError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/add_test_number_not_allowed_before_launch-2"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3":{"value":{"errorCode":"blocked_because_the_recipient_declined","message":"Blocked because the recipient declined.","resolution":"This operation is blocked because the recipient declined the invitation to become a tester."},"key":"blocked_because_the_recipient_declined-3","summary":"BlockedBecauseTheRecipientDeclinedError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/404/content/application~1json/examples/blocked_because_the_recipient_declined-3"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0":{"value":{"errorCode":"rbm_too_many_requests","message":"RCS Business Messaging too many requests.","resolution":"Please wait and try again."},"key":"rbm_too_many_requests-0","summary":"RbmTooManyRequestsError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/429/content/application~1json/examples/rbm_too_many_requests-0"},"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1rcs~1senders~1{senderId}~1testNumbers~1{testNumber}~1retry/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/200/content/application~1json/examples/response":{"value":{"totalSize":1,"pageSize":50,"smsApps":[{"id":"439fffeedc41494ca58b99a534139bb0","smsServiceId":"4b4ef32ba72d415cb259d179afa33d75","name":"Sms app name","status":"ACTIVE","regions":["EU"],"conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"test":false}]},"key":"response","summary":"List response","description":"\n    Response with sms apps.\n    ","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_token-0":{"value":{"errorCode":"invalid_page_token","message":"Invalid page token.","resolution":"The page token to use is provided in the previous query response, for new queries simply leave this field undefined."},"key":"invalid_page_token-0","summary":"InvalidPageTokenError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_token-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_size-1":{"value":{"errorCode":"invalid_page_size","message":"Page size must be numeric.","resolution":"Use a integer value for pageSize parameter."},"key":"invalid_page_size-1","summary":"InvalidPageSizeError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_page_size-1"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_id_format-2":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"projectId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-2","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/400/content/application~1json/examples/invalid_id_format-2"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/404/content/application~1json/examples/sms_service_not_found-0":{"value":{"errorCode":"sms_service_not_found","message":"SmsService not found.","resolution":"Verify that the projectId is correct."},"key":"sms_service_not_found-0","summary":"SmsServiceNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/404/content/application~1json/examples/sms_service_not_found-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe":{"value":{"name":"Sms app name","region":"EU"},"key":"europe","summary":"Create sms app","description":"Example body for creating an sms app.","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europe"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp":{"value":{"name":"Sms app name","region":"EU","convApiApp":true},"key":"europeWithConversationApiApp","summary":"Create sms app with conversation API app","description":"Example body for creating an sms app and a conversation API app.","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConversationApiApp"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId":{"value":{"name":"Sms app name","region":"EU","convApiAppId":"01KXD2MJSAN61CNE0CJ6VT6PXP"},"key":"europeWithConvApiAppId","summary":"Create sms app and connect to existing conversation API app","description":"Example body for creating an sms app and connecting to an existing conversation API app.","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/requestBody/content/application~1json/examples/europeWithConvApiAppId"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/201/content/application~1json/examples/europe":{"value":{"id":"439fffeedc41494ca58b99a534139bb0","smsServiceId":"4b4ef32ba72d415cb259d179afa33d75","name":"Sms app name","status":"ACTIVE","regions":["EU"],"conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"test":false},"key":"europe","summary":"Create response","description":"Response for successfully created sms app.","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/201/content/application~1json/examples/europe"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["Description of fields failing validation"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_payload-1":{"value":{"errorCode":"invalid_payload","message":"Invalid payload.","resolution":"Correct payload and submit again."},"key":"invalid_payload-1","summary":"InvalidPayloadError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/400/content/application~1json/examples/invalid_payload-1"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps/post/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/200/content/application~1json/examples/response":{"value":{"id":"439fffeedc41494ca58b99a534139bb0","smsServiceId":"4b4ef32ba72d415cb259d179afa33d75","name":"Sms app name","status":"ACTIVE","regions":["EU"],"conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"test":false},"key":"response","summary":"SMS App response","description":"\n    Response with single SMS app details.\n    ","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-1":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-1","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/401/content/application~1json/examples/unauthorized_error-1"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/404/content/application~1json/examples/sms_app_not_found-0":{"value":{"errorCode":"sms_app_not_found","message":"SmsApp not found.","resolution":"Verify that the appId is correct."},"key":"sms_app_not_found-0","summary":"SmsAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/404/content/application~1json/examples/sms_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/get/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0":{"value":{"errorCode":"invalid_id_format","message":"Id is not in the expected format.","resolution":"smsAppId param is in the wrong format. Confirm that you're sending the correct value."},"key":"invalid_id_format-0","summary":"InvalidIdFormatError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/400/content/application~1json/examples/invalid_id_format-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/404/content/application~1json/examples/sms_app_not_found-0":{"value":{"errorCode":"sms_app_not_found","message":"SmsApp not found.","resolution":"Verify that the appId is correct."},"key":"sms_app_not_found-0","summary":"SmsAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/404/content/application~1json/examples/sms_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/delete/responses/500/content/application~1json/examples/internal_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/200/content/application~1json/examples/response":{"value":{"id":"439fffeedc41494ca58b99a534139bb0","smsServiceId":"4b4ef32ba72d415cb259d179afa33d75","name":"Sms app name","status":"ACTIVE","regions":["EU"],"conversationApiAppDetails":{"id":"4CF9CE97504C4A468F4610919D17ECC1","projectId":"ea026751-3edf-40a9-ad93-1b382bd60a78","region":"EU","channelStatus":"ACTIVE"},"test":false},"key":"response","summary":"Update response","description":"Response for successfully updated sms app.","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/200/content/application~1json/examples/response"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/invalid_input-0":{"value":{"errorCode":"invalid_input","message":"Invalid input.","resolution":"Correct the validation errors and submit again.","additionalInformation":{"validationErrors":["Description of fields failing validation"]}},"key":"invalid_input-0","summary":"InvalidInputError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/invalid_input-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-1":{"value":{"errorCode":"no_fields_to_update","message":"No fields to be updated.","resolution":"Supply at least one field to be updated."},"key":"no_fields_to_update-1","summary":"NoFieldsToUpdateError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/400/content/application~1json/examples/no_fields_to_update-1"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0":{"value":{"errorCode":"unauthorized_error","message":"Unauthorized error.","resolution":"Verify that projectId is correct."},"key":"unauthorized_error-0","summary":"UnauthorizedErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/401/content/application~1json/examples/unauthorized_error-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/404/content/application~1json/examples/sms_app_not_found-0":{"value":{"errorCode":"sms_app_not_found","message":"SmsApp not found.","resolution":"Verify that the appId is correct."},"key":"sms_app_not_found-0","summary":"SmsAppNotFoundError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/404/content/application~1json/examples/sms_app_not_found-0"},"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/500/content/application~1json/examples/internal_error-0":{"value":{"errorCode":"internal_error","message":"Internal server error.","resolution":"Please wait and try again, if the error persist please contact support."},"key":"internal_error-0","summary":"InternalErrorError","id":"paths/~1v1~1projects~1{projectId}~1sms~1smsApps~1{smsAppId}/patch/responses/500/content/application~1json/examples/internal_error-0"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"},"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},"OAuth2Production":{"id":"OAuth2Production","type":"oauth2","description":"OAuth2 authorization for production","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{"-":"-"}}}}},"servers":[{"url":"https://provisioning.api.sinch.com","description":"Production server"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/provisioning-api/api-reference/provisioning-api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/provisioning-api/api-reference/provisioning-api.json?download"},{"url":"/_bundle/docs/provisioning-api/api-reference/provisioning-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Provisioning API","description":""}},"baseSlug":"/docs/provisioning-api/api-reference/provisioning-api","routesMapping":{}}